Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- ValidateResourcePolicy
- DeleteSecret
- ListSecrets (Paginated)
- UpdateSecret
- RemoveRegionsFromReplication
- RotateSecret
- CreateSecret
- GetSecretValue
- DescribeSecret
- RestoreSecret
- CancelRotateSecret
- GetResourcePolicy
- PutSecretValue
- ReplicateSecretToRegions
- StopReplicationToReplica
- GetRandomPassword
- ListSecretVersionIds (Paginated)
- TagResource
- PutResourcePolicy
- DeleteResourcePolicy
- UntagResource
- UpdateSecretVersionStage
- Types
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.
As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for 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.
How examples are presented
The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
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
- _MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _DecryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError
- _PublicPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError
- _PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data ValidateResourcePolicy = ValidateResourcePolicy' (Maybe Text) Text
- newValidateResourcePolicy :: Text -> ValidateResourcePolicy
- data ValidateResourcePolicyResponse = ValidateResourcePolicyResponse' (Maybe [ValidationErrorsEntry]) (Maybe Bool) Int
- newValidateResourcePolicyResponse :: Int -> ValidateResourcePolicyResponse
- data DeleteSecret = DeleteSecret' (Maybe Integer) (Maybe Bool) Text
- newDeleteSecret :: Text -> DeleteSecret
- data DeleteSecretResponse = DeleteSecretResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDeleteSecretResponse :: Int -> DeleteSecretResponse
- data ListSecrets = ListSecrets' (Maybe [Filter]) (Maybe Text) (Maybe SortOrderType) (Maybe Natural)
- newListSecrets :: ListSecrets
- data ListSecretsResponse = ListSecretsResponse' (Maybe Text) (Maybe [SecretListEntry]) Int
- newListSecretsResponse :: Int -> ListSecretsResponse
- data UpdateSecret = UpdateSecret' (Maybe (Sensitive Base64)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newUpdateSecret :: Text -> UpdateSecret
- data UpdateSecretResponse = UpdateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateSecretResponse :: Int -> UpdateSecretResponse
- data RemoveRegionsFromReplication = RemoveRegionsFromReplication' Text (NonEmpty Text)
- newRemoveRegionsFromReplication :: Text -> NonEmpty Text -> RemoveRegionsFromReplication
- data RemoveRegionsFromReplicationResponse = RemoveRegionsFromReplicationResponse' (Maybe Text) (Maybe [ReplicationStatusType]) Int
- newRemoveRegionsFromReplicationResponse :: Int -> RemoveRegionsFromReplicationResponse
- data RotateSecret = RotateSecret' (Maybe RotationRulesType) (Maybe Text) (Maybe Text) Text
- newRotateSecret :: Text -> RotateSecret
- data RotateSecretResponse = RotateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newRotateSecretResponse :: Int -> RotateSecretResponse
- data CreateSecret = CreateSecret' (Maybe (NonEmpty ReplicaRegionType)) (Maybe (Sensitive Base64)) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text
- newCreateSecret :: Text -> CreateSecret
- data CreateSecretResponse = CreateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ReplicationStatusType]) Int
- newCreateSecretResponse :: Int -> CreateSecretResponse
- data GetSecretValue = GetSecretValue' (Maybe Text) (Maybe Text) Text
- newGetSecretValue :: Text -> GetSecretValue
- data GetSecretValueResponse = GetSecretValueResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (Sensitive Base64)) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive Text)) Int
- newGetSecretValueResponse :: Int -> GetSecretValueResponse
- data DescribeSecret = DescribeSecret' Text
- newDescribeSecret :: Text -> DescribeSecret
- data DescribeSecretResponse = DescribeSecretResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RotationRulesType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (NonEmpty Text))) (Maybe [ReplicationStatusType]) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int
- newDescribeSecretResponse :: Int -> DescribeSecretResponse
- data RestoreSecret = RestoreSecret' Text
- newRestoreSecret :: Text -> RestoreSecret
- data RestoreSecretResponse = RestoreSecretResponse' (Maybe Text) (Maybe Text) Int
- newRestoreSecretResponse :: Int -> RestoreSecretResponse
- data CancelRotateSecret = CancelRotateSecret' Text
- newCancelRotateSecret :: Text -> CancelRotateSecret
- data CancelRotateSecretResponse = CancelRotateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCancelRotateSecretResponse :: Int -> CancelRotateSecretResponse
- data GetResourcePolicy = GetResourcePolicy' Text
- newGetResourcePolicy :: Text -> GetResourcePolicy
- data GetResourcePolicyResponse = GetResourcePolicyResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetResourcePolicyResponse :: Int -> GetResourcePolicyResponse
- data PutSecretValue = PutSecretValue' (Maybe (NonEmpty Text)) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe Text) Text
- newPutSecretValue :: Text -> PutSecretValue
- data PutSecretValueResponse = PutSecretValueResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) Int
- newPutSecretValueResponse :: Int -> PutSecretValueResponse
- 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 StopReplicationToReplica = StopReplicationToReplica' Text
- newStopReplicationToReplica :: Text -> StopReplicationToReplica
- data StopReplicationToReplicaResponse = StopReplicationToReplicaResponse' (Maybe Text) Int
- newStopReplicationToReplicaResponse :: Int -> StopReplicationToReplicaResponse
- data GetRandomPassword = GetRandomPassword' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural)
- newGetRandomPassword :: GetRandomPassword
- data GetRandomPasswordResponse = GetRandomPasswordResponse' (Maybe (Sensitive Text)) Int
- newGetRandomPasswordResponse :: Int -> GetRandomPasswordResponse
- data ListSecretVersionIds = ListSecretVersionIds' (Maybe Text) (Maybe Bool) (Maybe Natural) Text
- newListSecretVersionIds :: Text -> ListSecretVersionIds
- data ListSecretVersionIdsResponse = ListSecretVersionIdsResponse' (Maybe Text) (Maybe [SecretVersionsListEntry]) (Maybe Text) (Maybe Text) Int
- newListSecretVersionIdsResponse :: Int -> ListSecretVersionIdsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data PutResourcePolicy = PutResourcePolicy' (Maybe Bool) Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' (Maybe Text) (Maybe Text) Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateSecretVersionStage = UpdateSecretVersionStage' (Maybe Text) (Maybe Text) Text Text
- newUpdateSecretVersionStage :: Text -> Text -> UpdateSecretVersionStage
- data UpdateSecretVersionStageResponse = UpdateSecretVersionStageResponse' (Maybe Text) (Maybe Text) Int
- newUpdateSecretVersionStageResponse :: Int -> UpdateSecretVersionStageResponse
- newtype FilterNameStringType where
- FilterNameStringType' { }
- pattern FilterNameStringType_All :: FilterNameStringType
- pattern FilterNameStringType_Description :: FilterNameStringType
- pattern FilterNameStringType_Name :: 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 (NonEmpty Text)) (Maybe FilterNameStringType)
- newFilter :: Filter
- data ReplicaRegionType = ReplicaRegionType' (Maybe Text) (Maybe Text)
- newReplicaRegionType :: ReplicaRegionType
- data ReplicationStatusType = ReplicationStatusType' (Maybe StatusType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newReplicationStatusType :: ReplicationStatusType
- data RotationRulesType = RotationRulesType' (Maybe Natural)
- newRotationRulesType :: RotationRulesType
- data SecretListEntry = SecretListEntry' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (NonEmpty Text))) (Maybe RotationRulesType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Tag])
- newSecretListEntry :: SecretListEntry
- data SecretVersionsListEntry = SecretVersionsListEntry' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe [Text]) (Maybe POSIX)
- 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
.
MalformedPolicyDocumentException
_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided a resource-based policy with syntax errors.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided an invalid value for a parameter.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
DecryptionFailure
_DecryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
PublicPolicyException
_PublicPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
EncryptionFailure
_EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
PreconditionNotMetException
_PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because you did not complete all the prerequisite steps.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided an invalid NextToken
value.
InternalServiceError
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred on the server side.
ResourceExistsException
_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource with the ID you requested already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find the resource that you asked for.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because it would exceed one of the Secrets Manager internal limits.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ValidateResourcePolicy
data ValidateResourcePolicy Source #
See: newValidateResourcePolicy
smart constructor.
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
- (Optional) The identifier of the secret with the resource-based policy
you want to validate. 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.
$sel:resourcePolicy:ValidateResourcePolicy'
, validateResourcePolicy_resourcePolicy
- A JSON-formatted string constructed according to the grammar and syntax
for an Amazon Web Services resource-based policy. The policy in the
string identifies who can access or manage this secret and its versions.
For information on how to format a JSON parameter for the various
command line tool environments, see
Using JSON for Parameters
in the CLI User Guide.publi
data ValidateResourcePolicyResponse Source #
See: newValidateResourcePolicyResponse
smart constructor.
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:validationErrors:ValidateResourcePolicyResponse'
, validateResourcePolicyResponse_validationErrors
- Returns an error message if your policy doesn't pass validatation.
$sel:policyValidationPassed:ValidateResourcePolicyResponse'
, validateResourcePolicyResponse_policyValidationPassed
- Returns a message stating that your Reource Policy passed validation.
$sel:httpStatus:ValidateResourcePolicyResponse'
, validateResourcePolicyResponse_httpStatus
- The response's http status code.
DeleteSecret
data DeleteSecret Source #
See: newDeleteSecret
smart constructor.
Instances
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:recoveryWindowInDays:DeleteSecret'
, deleteSecret_recoveryWindowInDays
- (Optional) Specifies the number of days that Secrets Manager waits
before Secrets Manager can delete the secret. You can't use both this
parameter and the ForceDeleteWithoutRecovery
parameter in the same API
call.
This value can range from 7 to 30 days with a default value of 30.
$sel:forceDeleteWithoutRecovery:DeleteSecret'
, deleteSecret_forceDeleteWithoutRecovery
- (Optional) Specifies that the secret is to be deleted without any
recovery window. You can't use both this parameter and the
RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to
skip the normal waiting period before the permanent deletion that Amazon
Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose
the secret permanently.
If you use this parameter and include a previously deleted or
nonexistent secret, the operation does not return the error
ResourceNotFoundException
in order to correctly handle retries.
$sel:secretId:DeleteSecret'
, deleteSecret_secretId
- Specifies the secret to delete. 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.
data DeleteSecretResponse Source #
See: newDeleteSecretResponse
smart constructor.
Instances
newDeleteSecretResponse Source #
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:
$sel:arn:DeleteSecretResponse'
, deleteSecretResponse_arn
- The ARN of the secret that is now scheduled for deletion.
$sel:name:DeleteSecretResponse'
, deleteSecretResponse_name
- The friendly name of the secret currently scheduled for deletion.
$sel:deletionDate:DeleteSecretResponse'
, deleteSecretResponse_deletionDate
- The date and time after which this secret can be deleted by Secrets
Manager and can no longer be restored. This value is the date and time
of the delete request plus the number of days specified in
RecoveryWindowInDays
.
$sel:httpStatus:DeleteSecretResponse'
, deleteSecretResponse_httpStatus
- The response's http status code.
ListSecrets (Paginated)
data ListSecrets Source #
See: newListSecrets
smart constructor.
ListSecrets' (Maybe [Filter]) (Maybe Text) (Maybe SortOrderType) (Maybe Natural) |
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
- Lists the secret request filters.
$sel:nextToken:ListSecrets'
, listSecrets_nextToken
- (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output
available. In a subsequent call, set it to the value of the previous
call NextToken
response to indicate where the output should continue
from.
$sel:sortOrder:ListSecrets'
, listSecrets_sortOrder
- Lists secrets in the requested order.
$sel:maxResults:ListSecrets'
, listSecrets_maxResults
- (Optional) Limits the number of results you want to include in the
response. If you don't include this parameter, it defaults to a value
that's specific to the operation. If additional items exist beyond the
maximum you specify, the NextToken
response element is present and has
a value (isn't null). Include that value as the NextToken
request
parameter in the next call to the operation to get the next part of the
results. Note that Secrets Manager might return fewer results than the
maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the
results.
data ListSecretsResponse Source #
See: newListSecretsResponse
smart constructor.
Instances
newListSecretsResponse Source #
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:
$sel:nextToken:ListSecrets'
, listSecretsResponse_nextToken
- If present in the response, this value indicates that there's more
output available than 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 very long list. Use this value in the
NextToken
request parameter in a subsequent call to the operation to
continue processing and get the next part of the output. You should
repeat this until the NextToken
response element comes back empty (as
null
).
$sel:secretList:ListSecretsResponse'
, listSecretsResponse_secretList
- A list of the secrets in the account.
$sel:httpStatus:ListSecretsResponse'
, listSecretsResponse_httpStatus
- The response's http status code.
UpdateSecret
data UpdateSecret Source #
See: newUpdateSecret
smart constructor.
UpdateSecret' (Maybe (Sensitive Base64)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text |
Instances
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:secretBinary:UpdateSecret'
, updateSecret_secretBinary
- (Optional) Specifies updated binary data that you want 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 use the appropriate technique for your tool to pass the
contents of the file as a parameter. Either SecretBinary
or
SecretString
must have a value, but not both. They cannot both be
empty.
This parameter is not accessible using 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:kmsKeyId:UpdateSecret'
, updateSecret_kmsKeyId
- (Optional) Specifies an updated ARN or alias of the Amazon Web Services
KMS customer master key (CMK) that Secrets Manager uses to encrypt the
protected text in new versions of this secret as well as any existing
versions of this secret that have the staging labels AWSCURRENT,
AWSPENDING, or AWSPREVIOUS. For more information about staging labels,
see
Staging Labels
in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
$sel:secretString:UpdateSecret'
, updateSecret_secretString
- (Optional) Specifies updated text data that you want to encrypt and
store in this new version of the secret. Either SecretBinary
or
SecretString
must have a value, but not both. They cannot both be
empty.
If you create this 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 the default
Lambda rotation function knows how to parse.
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.
$sel:clientRequestToken:UpdateSecret'
, updateSecret_clientRequestToken
- (Optional) If you want to add a new version to the secret, this
parameter specifies a unique identifier for the new version that helps
ensure idempotency.
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. 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 typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
- If the
ClientRequestToken
value 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
SecretString
andSecretBinary
values 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 that version's
SecretString
andSecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
$sel:description:UpdateSecret'
, updateSecret_description
- (Optional) Specifies an updated user-provided description of the secret.
$sel:secretId:UpdateSecret'
, updateSecret_secretId
- Specifies the secret that you want to modify or to which you want to add
a new version. 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.
data UpdateSecretResponse Source #
See: newUpdateSecretResponse
smart constructor.
Instances
newUpdateSecretResponse Source #
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:
$sel:versionId:UpdateSecretResponse'
, updateSecretResponse_versionId
- If a new version of the secret was created by this operation, then
VersionId
contains the unique identifier of the new version.
$sel:arn:UpdateSecretResponse'
, updateSecretResponse_arn
- The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
$sel:name:UpdateSecretResponse'
, updateSecretResponse_name
- The friendly name of the secret that was updated.
$sel:httpStatus:UpdateSecretResponse'
, updateSecretResponse_httpStatus
- The response's http status code.
RemoveRegionsFromReplication
data RemoveRegionsFromReplication Source #
See: newRemoveRegionsFromReplication
smart constructor.
Instances
newRemoveRegionsFromReplication Source #
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
- Remove a secret by SecretId
from replica Regions.
$sel:removeReplicaRegions:RemoveRegionsFromReplication'
, removeRegionsFromReplication_removeReplicaRegions
- Remove replication from specific Regions.
data RemoveRegionsFromReplicationResponse Source #
See: newRemoveRegionsFromReplicationResponse
smart constructor.
Instances
newRemoveRegionsFromReplicationResponse Source #
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:
$sel:arn:RemoveRegionsFromReplicationResponse'
, removeRegionsFromReplicationResponse_arn
- The secret ARN
removed from replication regions.
$sel:replicationStatus:RemoveRegionsFromReplicationResponse'
, removeRegionsFromReplicationResponse_replicationStatus
- Describes the remaining replication status after you remove regions from
the replication list.
$sel:httpStatus:RemoveRegionsFromReplicationResponse'
, removeRegionsFromReplicationResponse_httpStatus
- The response's http status code.
RotateSecret
data RotateSecret Source #
See: newRotateSecret
smart constructor.
Instances
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:rotationRules:RotateSecret'
, rotateSecret_rotationRules
- A structure that defines the rotation configuration for this secret.
$sel:clientRequestToken:RotateSecret'
, rotateSecret_clientRequestToken
- (Optional) Specifies a unique identifier for the new version of the
secret that helps ensure idempotency.
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 your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of
duplicate versions if there are failures and retries during the
function's processing. This value becomes the VersionId
of the new
version.
$sel:rotationLambdaARN:RotateSecret'
, rotateSecret_rotationLambdaARN
- (Optional) Specifies the ARN of the Lambda function that can rotate the
secret.
$sel:secretId:RotateSecret'
, rotateSecret_secretId
- Specifies the secret that you want to rotate. 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.
data RotateSecretResponse Source #
See: newRotateSecretResponse
smart constructor.
Instances
newRotateSecretResponse Source #
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:
$sel:versionId:RotateSecretResponse'
, rotateSecretResponse_versionId
- The ID of the new version of the secret created by the rotation started
by this request.
$sel:arn:RotateSecretResponse'
, rotateSecretResponse_arn
- The ARN of the secret.
$sel:name:RotateSecretResponse'
, rotateSecretResponse_name
- The friendly name of the secret.
$sel:httpStatus:RotateSecretResponse'
, rotateSecretResponse_httpStatus
- The response's http status code.
CreateSecret
data CreateSecret Source #
See: newCreateSecret
smart constructor.
CreateSecret' (Maybe (NonEmpty ReplicaRegionType)) (Maybe (Sensitive Base64)) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text |
Instances
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
- (Optional) Add a list of regions to replicate secrets. Secrets Manager
replicates the KMSKeyID objects to the list of regions specified in the
parameter.
$sel:secretBinary:CreateSecret'
, createSecret_secretBinary
- (Optional) Specifies binary data that you want 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
use the appropriate technique for your tool to pass the contents of the
file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
They cannot both be empty.
This parameter is not available using the Secrets Manager console. It
can be accessed only by using the Amazon Web Services CLI or one of the
Amazon Web Services SDKs.--
-- 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:kmsKeyId:CreateSecret'
, createSecret_kmsKeyId
- (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web
Services KMS customer master key (CMK) to be used to encrypt the
SecretString
or SecretBinary
values in the versions stored in this
secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using
the Amazon Web Services account's default CMK (the one named
aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name
doesn't yet exist, then Secrets Manager creates it for you
automatically the first time it needs to encrypt a version's
SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
$sel:forceOverwriteReplicaSecret:CreateSecret'
, createSecret_forceOverwriteReplicaSecret
- (Optional) If set, the replication overwrites a secret with the same
name in the destination region.
$sel:secretString:CreateSecret'
, createSecret_secretString
- (Optional) Specifies text data that you want to encrypt and store in
this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both.
They cannot both be empty.
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 the Lambda rotation function knows
how to parse.
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.
$sel:clientRequestToken:CreateSecret'
, createSecret_clientRequestToken
- (Optional) If you include SecretString
or SecretBinary
, then an
initial version is created as part of the secret, and this parameter
specifies a unique identifier for 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 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
ClientRequestToken
value 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
SecretString
andSecretBinary
values 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
SecretString
andSecretBinary
values 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.
$sel:description:CreateSecret'
, createSecret_description
- (Optional) Specifies a user-provided description of the secret.
$sel:tags:CreateSecret'
, createSecret_tags
- (Optional) Specifies a list of user-defined tags that are attached to
the secret. Each tag is a "Key" and "Value" pair of strings. This
operation only appends tags to the existing list of tags. To remove
tags, you must use UntagResource.
- 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 IAM policy
Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns anAccess Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
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 basic 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
$sel:name:CreateSecret'
, createSecret_name
- Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or 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 at the end of the ARN.
data CreateSecretResponse Source #
See: newCreateSecretResponse
smart constructor.
Instances
newCreateSecretResponse Source #
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:
$sel:versionId:CreateSecretResponse'
, createSecretResponse_versionId
- The unique identifier associated with the version of the secret you just
created.
$sel:arn:CreateSecretResponse'
, createSecretResponse_arn
- The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
$sel:name:CreateSecret'
, createSecretResponse_name
- The friendly name of the secret that you just created.
$sel:replicationStatus:CreateSecretResponse'
, createSecretResponse_replicationStatus
- Describes a list of replication status objects as InProgress
, Failed
or InSync
.
$sel:httpStatus:CreateSecretResponse'
, createSecretResponse_httpStatus
- The response's http status code.
GetSecretValue
data GetSecretValue Source #
See: newGetSecretValue
smart constructor.
Instances
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:
$sel:versionId:GetSecretValue'
, getSecretValue_versionId
- Specifies the unique identifier of the version of the secret that you
want to retrieve. If you specify 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 the default is to
perform the operation on the version with the VersionStage
value of
AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
$sel:versionStage:GetSecretValue'
, getSecretValue_versionStage
- Specifies the secret version that you want to retrieve by the staging
label attached to the version.
Staging labels are used to keep track of different versions during the
rotation process. If you specify 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
, then the default is to
perform the operation on the version with the VersionStage
value of
AWSCURRENT
.
$sel:secretId:GetSecretValue'
, getSecretValue_secretId
- Specifies the secret containing the version that you want to retrieve.
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.
data GetSecretValueResponse Source #
See: newGetSecretValueResponse
smart constructor.
GetSecretValueResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (Sensitive Base64)) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive 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:
$sel:versionId:GetSecretValue'
, getSecretValueResponse_versionId
- The unique identifier of this version of the secret.
$sel:arn:GetSecretValueResponse'
, getSecretValueResponse_arn
- The ARN of the secret.
$sel:versionStages:GetSecretValueResponse'
, getSecretValueResponse_versionStages
- A list of all of the staging labels currently attached to this version
of the secret.
$sel:secretBinary:GetSecretValueResponse'
, getSecretValueResponse_secretBinary
- The decrypted part of the protected secret information that 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.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you
must code your Lambda rotation function to parse and interpret whatever
you store in the SecretString
or SecretBinary
fields.--
-- 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:createdDate:GetSecretValueResponse'
, getSecretValueResponse_createdDate
- The date and time that this version of the secret was created.
$sel:name:GetSecretValueResponse'
, getSecretValueResponse_name
- The friendly name of the secret.
$sel:secretString:GetSecretValueResponse'
, getSecretValueResponse_secretString
- The decrypted part of the protected secret information that was
originally provided as a string.
If you create this secret by using the Secrets Manager console then only
the SecretString
parameter contains data. Secrets Manager stores the
information as a JSON structure of key/value pairs that the Lambda
rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
$sel:httpStatus:GetSecretValueResponse'
, getSecretValueResponse_httpStatus
- The response's http status code.
DescribeSecret
data DescribeSecret Source #
See: newDescribeSecret
smart constructor.
Instances
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 identifier of the secret whose details you want to retrieve. 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.
data DescribeSecretResponse Source #
See: newDescribeSecretResponse
smart constructor.
DescribeSecretResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RotationRulesType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (NonEmpty Text))) (Maybe [ReplicationStatusType]) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Tag]) 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:
$sel:lastChangedDate:DescribeSecretResponse'
, describeSecretResponse_lastChangedDate
- The last date and time that this secret was modified in any way.
$sel:primaryRegion:DescribeSecretResponse'
, describeSecretResponse_primaryRegion
- Specifies the primary region for secret replication.
$sel:arn:DescribeSecretResponse'
, describeSecretResponse_arn
- The ARN of the secret.
$sel:rotationRules:DescribeSecretResponse'
, describeSecretResponse_rotationRules
- A structure with the rotation configuration for this secret. This field
is only populated if rotation is configured.
$sel:deletedDate:DescribeSecretResponse'
, describeSecretResponse_deletedDate
- This value exists if the secret is scheduled for deletion. Some time
after the specified date and time, Secrets Manager deletes the secret
and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
$sel:rotationEnabled:DescribeSecretResponse'
, describeSecretResponse_rotationEnabled
- Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use
CancelRotateSecret.
$sel:createdDate:DescribeSecretResponse'
, describeSecretResponse_createdDate
- The date you created the secret.
$sel:kmsKeyId:DescribeSecretResponse'
, describeSecretResponse_kmsKeyId
- The ARN or alias of the Amazon Web Services KMS customer master key
(CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then
Secrets Manager defaults to encrypting the secret fields with the
default Amazon Web Services KMS CMK (the one named awssecretsmanager
)
for this account.
$sel:name:DescribeSecretResponse'
, describeSecretResponse_name
- The user-provided friendly name of the secret.
$sel:versionIdsToStages:DescribeSecretResponse'
, describeSecretResponse_versionIdsToStages
- A list of all of the currently assigned VersionStage
staging labels
and the VersionId
that each is attached to. Staging labels are used to
keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
$sel:replicationStatus:DescribeSecretResponse'
, describeSecretResponse_replicationStatus
- Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
$sel:owningService:DescribeSecretResponse'
, describeSecretResponse_owningService
- Returns the name of the service that created this secret.
$sel:lastRotatedDate:DescribeSecretResponse'
, describeSecretResponse_lastRotatedDate
- The last date and time that the rotation process for this secret was
invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
$sel:lastAccessedDate:DescribeSecretResponse'
, describeSecretResponse_lastAccessedDate
- The last date that this secret was accessed. This value is truncated to
midnight of the date and therefore shows only the date, not the time.
$sel:description:DescribeSecretResponse'
, describeSecretResponse_description
- The user-provided description of the secret.
$sel:rotationLambdaARN:DescribeSecretResponse'
, describeSecretResponse_rotationLambdaARN
- The ARN of a Lambda function that's invoked by Secrets Manager to
rotate the secret either automatically per the schedule or manually by a
call to RotateSecret
.
$sel:tags:DescribeSecretResponse'
, describeSecretResponse_tags
- The list of user-defined tags that are associated with the secret. To
add tags to a secret, use TagResource. To remove tags, use
UntagResource.
$sel:httpStatus:DescribeSecretResponse'
, describeSecretResponse_httpStatus
- The response's http status code.
RestoreSecret
data RestoreSecret Source #
See: newRestoreSecret
smart constructor.
Instances
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
- Specifies the secret that you want to restore from a previously
scheduled deletion. 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.
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:
$sel:arn:RestoreSecretResponse'
, restoreSecretResponse_arn
- The ARN of the secret that was restored.
$sel:name:RestoreSecretResponse'
, restoreSecretResponse_name
- The friendly name of the secret that was restored.
$sel:httpStatus:RestoreSecretResponse'
, restoreSecretResponse_httpStatus
- The response's http status code.
CancelRotateSecret
data CancelRotateSecret Source #
See: newCancelRotateSecret
smart constructor.
Instances
newCancelRotateSecret Source #
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
- Specifies the secret to cancel a rotation request. 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.
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:
$sel:versionId: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. At the very least, you should remove the
VersionStage
value AWSPENDING
to enable this version to be deleted.
Failing to clean up a cancelled rotation can block you from successfully
starting future rotations.
$sel:arn:CancelRotateSecretResponse'
, cancelRotateSecretResponse_arn
- The ARN of the secret for which rotation was canceled.
$sel:name:CancelRotateSecretResponse'
, cancelRotateSecretResponse_name
- The friendly name of the secret for which rotation was canceled.
$sel:httpStatus:CancelRotateSecretResponse'
, cancelRotateSecretResponse_httpStatus
- The response's http status code.
GetResourcePolicy
data GetResourcePolicy Source #
See: newGetResourcePolicy
smart constructor.
Instances
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
- Specifies the secret that you want to retrieve the attached
resource-based policy for. 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.
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:
$sel:resourcePolicy:GetResourcePolicyResponse'
, getResourcePolicyResponse_resourcePolicy
- A JSON-formatted string that describes the permissions that are
associated with the attached secret. These permissions are combined with
any permissions that are associated with the user or role that attempts
to access this secret. The combined permissions specify who can access
the secret and what actions they can perform. For more information, see
Authentication and Access Control for Amazon Web Services Secrets Manager
in the Amazon Web Services Secrets Manager User Guide.
$sel:arn:GetResourcePolicyResponse'
, getResourcePolicyResponse_arn
- The ARN of the secret that the resource-based policy was retrieved for.
$sel:name:GetResourcePolicyResponse'
, getResourcePolicyResponse_name
- The friendly name of the secret that the resource-based policy was
retrieved for.
$sel:httpStatus:GetResourcePolicyResponse'
, getResourcePolicyResponse_httpStatus
- The response's http status code.
PutSecretValue
data PutSecretValue Source #
See: newPutSecretValue
smart constructor.
PutSecretValue' (Maybe (NonEmpty Text)) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe Text) Text |
Instances
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:versionStages:PutSecretValue'
, putSecretValue_versionStages
- (Optional) Specifies a list of staging labels that are attached to this
version of the secret. These staging labels are used to track the
versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager
automatically moves the staging label AWSCURRENT
to this new version.
$sel:secretBinary:PutSecretValue'
, putSecretValue_secretBinary
- (Optional) Specifies binary data that you want 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
use the appropriate technique for your tool to pass the contents of the
file as a parameter. Either SecretBinary
or SecretString
must have a
value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using 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
- (Optional) Specifies text data that you want to encrypt and store in
this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this 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 the default
Lambda rotation function knows how to parse.
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.
$sel:clientRequestToken:PutSecretValue'
, putSecretValue_clientRequestToken
- (Optional) Specifies 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
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. 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's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
- If the
ClientRequestToken
value 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
SecretString
orSecretBinary
values 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
SecretString
andSecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
$sel:secretId:PutSecretValue'
, putSecretValue_secretId
- Specifies the secret to which you want to add a new version. You can
specify either the Amazon Resource Name (ARN) or the friendly name of
the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
data PutSecretValueResponse Source #
See: newPutSecretValueResponse
smart constructor.
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:
$sel:versionId:PutSecretValueResponse'
, putSecretValueResponse_versionId
- The unique identifier of the version of the secret you just created or
updated.
$sel:arn:PutSecretValueResponse'
, putSecretValueResponse_arn
- The Amazon Resource Name (ARN) for the secret for which you just created
a version.
$sel:versionStages:PutSecretValue'
, putSecretValueResponse_versionStages
- The list of staging labels that are currently attached to this version
of the secret. Staging labels are used to track a version as it
progresses through the secret rotation process.
$sel:name:PutSecretValueResponse'
, putSecretValueResponse_name
- The friendly name of the secret for which you just created or updated a
version.
$sel:httpStatus:PutSecretValueResponse'
, putSecretValueResponse_httpStatus
- The response's http status code.
ReplicateSecretToRegions
data ReplicateSecretToRegions Source #
See: newReplicateSecretToRegions
smart constructor.
Instances
newReplicateSecretToRegions Source #
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
- (Optional) If set, Secrets Manager replication overwrites a secret with
the same name in the destination region.
$sel:secretId:ReplicateSecretToRegions'
, replicateSecretToRegions_secretId
- Use the Secret Id
to replicate a secret to regions.
$sel:addReplicaRegions:ReplicateSecretToRegions'
, replicateSecretToRegions_addReplicaRegions
- Add Regions to replicate the secret.
data ReplicateSecretToRegionsResponse Source #
See: newReplicateSecretToRegionsResponse
smart constructor.
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:
$sel:arn:ReplicateSecretToRegionsResponse'
, replicateSecretToRegionsResponse_arn
- Replicate a secret based on the ReplicaRegionType
> consisting of a
Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID,
or Alias.
$sel:replicationStatus:ReplicateSecretToRegionsResponse'
, replicateSecretToRegionsResponse_replicationStatus
- Describes the secret replication status as PENDING
, SUCCESS
or
FAIL
.
$sel:httpStatus:ReplicateSecretToRegionsResponse'
, replicateSecretToRegionsResponse_httpStatus
- The response's http status code.
StopReplicationToReplica
data StopReplicationToReplica Source #
See: newStopReplicationToReplica
smart constructor.
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
- Response to StopReplicationToReplica
of a secret, based on the
SecretId
.
data StopReplicationToReplicaResponse Source #
See: newStopReplicationToReplicaResponse
smart constructor.
Instances
Eq StopReplicationToReplicaResponse Source # | |
Read StopReplicationToReplicaResponse Source # | |
Show StopReplicationToReplicaResponse Source # | |
Generic StopReplicationToReplicaResponse Source # | |
NFData StopReplicationToReplicaResponse Source # | |
Defined in Amazonka.SecretsManager.StopReplicationToReplica rnf :: StopReplicationToReplicaResponse -> () # | |
type Rep StopReplicationToReplicaResponse Source # | |
Defined in Amazonka.SecretsManager.StopReplicationToReplica type Rep StopReplicationToReplicaResponse = D1 ('MetaData "StopReplicationToReplicaResponse" "Amazonka.SecretsManager.StopReplicationToReplica" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "StopReplicationToReplicaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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:
$sel:arn:StopReplicationToReplicaResponse'
, stopReplicationToReplicaResponse_arn
- Response StopReplicationToReplica
of a secret, based on the ARN,
.
$sel:httpStatus:StopReplicationToReplicaResponse'
, stopReplicationToReplicaResponse_httpStatus
- The response's http status code.
GetRandomPassword
data GetRandomPassword Source #
See: newGetRandomPassword
smart constructor.
GetRandomPassword' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural) |
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:includeSpace:GetRandomPassword'
, getRandomPassword_includeSpace
- Specifies that the generated password can include the space character.
The default if you do not include this switch parameter is that the
space character is not included.
$sel:excludeNumbers:GetRandomPassword'
, getRandomPassword_excludeNumbers
- Specifies that the generated password should not include digits. The
default if you do not include this switch parameter is that digits can
be included.
$sel:excludeLowercase:GetRandomPassword'
, getRandomPassword_excludeLowercase
- Specifies that the generated password should not include lowercase
letters. The default if you do not include this switch parameter is that
lowercase letters can be included.
$sel:excludeCharacters:GetRandomPassword'
, getRandomPassword_excludeCharacters
- A string that includes characters that should not be included in the
generated password. The default is that all characters from the included
sets can be used.
$sel:excludePunctuation:GetRandomPassword'
, getRandomPassword_excludePunctuation
- Specifies that the generated password should not include punctuation
characters. The default if you do not include this switch parameter is
that punctuation characters can be included.
The following are the punctuation characters that can be included in
the generated password if you don't explicitly exclude them with
ExcludeCharacters
or ExcludePunctuation
:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
$sel:requireEachIncludedType:GetRandomPassword'
, getRandomPassword_requireEachIncludedType
- A boolean value that specifies whether the generated password must
include at least one of every allowed character type. The default value
is True
and the operation requires at least one of every character
type.
$sel:excludeUppercase:GetRandomPassword'
, getRandomPassword_excludeUppercase
- Specifies that the generated password should not include uppercase
letters. The default if you do not include this switch parameter is that
uppercase letters can be included.
$sel:passwordLength:GetRandomPassword'
, getRandomPassword_passwordLength
- The desired length of the generated password. The default value if you
do not include this parameter is 32 characters.
data GetRandomPasswordResponse Source #
See: newGetRandomPasswordResponse
smart constructor.
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 generated password.
$sel:httpStatus:GetRandomPasswordResponse'
, getRandomPasswordResponse_httpStatus
- The response's http status code.
ListSecretVersionIds (Paginated)
data ListSecretVersionIds Source #
See: newListSecretVersionIds
smart constructor.
Instances
newListSecretVersionIds Source #
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:nextToken:ListSecretVersionIds'
, listSecretVersionIds_nextToken
- (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output
available. In a subsequent call, set it to the value of the previous
call NextToken
response to indicate where the output should continue
from.
$sel:includeDeprecated:ListSecretVersionIds'
, listSecretVersionIds_includeDeprecated
- (Optional) Specifies that you want the results to include versions that
do not have any staging labels attached to them. Such versions are
considered deprecated and are subject to deletion by Secrets Manager as
needed.
$sel:maxResults:ListSecretVersionIds'
, listSecretVersionIds_maxResults
- (Optional) Limits the number of results you want to include in the
response. If you don't include this parameter, it defaults to a value
that's specific to the operation. If additional items exist beyond the
maximum you specify, the NextToken
response element is present and has
a value (isn't null). Include that value as the NextToken
request
parameter in the next call to the operation to get the next part of the
results. Note that Secrets Manager might return fewer results than the
maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the
results.
$sel:secretId:ListSecretVersionIds'
, listSecretVersionIds_secretId
- The identifier for the secret containing the versions you want to list.
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.
data ListSecretVersionIdsResponse Source #
See: newListSecretVersionIdsResponse
smart constructor.
ListSecretVersionIdsResponse' (Maybe Text) (Maybe [SecretVersionsListEntry]) (Maybe Text) (Maybe Text) 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:
$sel:arn:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_arn
- The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
$sel:versions:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_versions
- The list of the currently available versions of the specified secret.
$sel:nextToken:ListSecretVersionIds'
, listSecretVersionIdsResponse_nextToken
- If present in the response, this value indicates that there's more
output available than 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 very long list. Use this value in the
NextToken
request parameter in a subsequent call to the operation to
continue processing and get the next part of the output. You should
repeat this until the NextToken
response element comes back empty (as
null
).
$sel:name:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_name
- The friendly name of the secret.
$sel:httpStatus:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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 that you want 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.
$sel:tags:TagResource'
, tagResource_tags
- The tags to attach to the secret. Each element in the list consists of a
Key
and a Value
.
This parameter to the API 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 TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Eq TagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
Generic TagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.TagResource rnf :: TagResourceResponse -> () # | |
type Rep TagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.TagResource |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy
smart constructor.
Instances
:: 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
- (Optional) If you set the parameter, BlockPublicPolicy
to true, then
you block resource-based policies that allow broad access to the secret.
$sel:secretId:PutResourcePolicy'
, putResourcePolicy_secretId
- Specifies the secret that you want to attach the resource-based policy.
You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
$sel:resourcePolicy:PutResourcePolicy'
, putResourcePolicy_resourcePolicy
- A JSON-formatted string constructed according to the grammar and syntax
for an Amazon Web Services resource-based policy. The policy in the
string identifies who can access or manage this secret and its versions.
For information on how to format a JSON parameter for the various
command line tool environments, see
Using JSON for Parameters
in the CLI User Guide.
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:
$sel:arn:PutResourcePolicyResponse'
, putResourcePolicyResponse_arn
- The ARN of the secret retrieved by the resource-based policy.
$sel:name:PutResourcePolicyResponse'
, putResourcePolicyResponse_name
- The friendly name of the secret retrieved by the resource-based policy.
$sel:httpStatus:PutResourcePolicyResponse'
, putResourcePolicyResponse_httpStatus
- The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy
smart constructor.
Instances
newDeleteResourcePolicy Source #
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
- Specifies the secret that you want to delete the attached resource-based
policy for. 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.
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:
$sel:arn:DeleteResourcePolicyResponse'
, deleteResourcePolicyResponse_arn
- The ARN of the secret that the resource-based policy was deleted for.
$sel:name:DeleteResourcePolicyResponse'
, deleteResourcePolicyResponse_name
- The friendly name of the secret that the resource-based policy was
deleted for.
$sel:httpStatus:DeleteResourcePolicyResponse'
, deleteResourcePolicyResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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 identifier for the secret that you want to remove tags from. 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.
$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 to the API 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.
Instances
Eq UntagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
Generic UntagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.UntagResource rnf :: UntagResourceResponse -> () # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.SecretsManager.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateSecretVersionStage
data UpdateSecretVersionStage Source #
See: newUpdateSecretVersionStage
smart constructor.
Instances
newUpdateSecretVersionStage Source #
:: 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:removeFromVersionId:UpdateSecretVersionStage'
, updateSecretVersionStage_removeFromVersionId
- Specifies the secret version 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:moveToVersionId:UpdateSecretVersionStage'
, updateSecretVersionStage_moveToVersionId
- (Optional) The secret version ID that you want to add the staging label.
If you want 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:secretId:UpdateSecretVersionStage'
, updateSecretVersionStage_secretId
- Specifies the secret with the version with the list of staging labels
you want to modify. 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.
$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:
$sel:arn:UpdateSecretVersionStageResponse'
, updateSecretVersionStageResponse_arn
- The ARN of the secret with the modified staging label.
$sel:name:UpdateSecretVersionStageResponse'
, updateSecretVersionStageResponse_name
- The friendly name of the secret with the modified staging label.
$sel:httpStatus:UpdateSecretVersionStageResponse'
, updateSecretVersionStageResponse_httpStatus
- The response's http status code.
Types
FilterNameStringType
newtype FilterNameStringType Source #
pattern FilterNameStringType_All :: FilterNameStringType | |
pattern FilterNameStringType_Description :: FilterNameStringType | |
pattern FilterNameStringType_Name :: FilterNameStringType | |
pattern FilterNameStringType_Primary_region :: FilterNameStringType | |
pattern FilterNameStringType_Tag_key :: FilterNameStringType | |
pattern FilterNameStringType_Tag_value :: FilterNameStringType |
Instances
SortOrderType
newtype SortOrderType Source #
pattern SortOrderType_Asc :: SortOrderType | |
pattern SortOrderType_Desc :: SortOrderType |
Instances
StatusType
newtype StatusType Source #
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.
See: newFilter
smart constructor.
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter | |
ToJSON 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" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterNameStringType)))) |
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:values:Filter'
, filter_values
- Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order
to perform negation filters.
$sel:key:Filter'
, filter_key
- Filters your list of secrets by a specific key.
ReplicaRegionType
data ReplicaRegionType Source #
(Optional) Custom type consisting of a Region
(required) and the
KmsKeyId
which can be an ARN
, Key ID
, or Alias
.
See: newReplicaRegionType
smart constructor.
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
- Can be an ARN
, Key ID
, or Alias
.
$sel:region:ReplicaRegionType'
, replicaRegionType_region
- Describes a single instance of Region objects.
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.
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:status:ReplicationStatusType'
, replicationStatusType_status
- The status can be InProgress
, Failed
, or InSync
.
$sel:kmsKeyId:ReplicationStatusType'
, replicationStatusType_kmsKeyId
- Can be an ARN
, Key ID
, or Alias
.
$sel:statusMessage:ReplicationStatusType'
, replicationStatusType_statusMessage
- Status message such as "/Secret with this name already exists in this
region/".
$sel:region:ReplicationStatusType'
, replicationStatusType_region
- The Region where replication occurs.
$sel:lastAccessedDate:ReplicationStatusType'
, replicationStatusType_lastAccessedDate
- The date that you last accessed the secret in the 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
- Specifies the number of days between automatic scheduled rotations of
the secret.
Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.
SecretListEntry
data SecretListEntry Source #
A structure that contains the details about a secret. It does not
include the encrypted SecretString
and SecretBinary
values. To get
those values, use the GetSecretValue operation.
See: newSecretListEntry
smart constructor.
SecretListEntry' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (NonEmpty Text))) (Maybe RotationRulesType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe 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:lastChangedDate:SecretListEntry'
, secretListEntry_lastChangedDate
- The last date and time that this secret was modified in any way.
$sel:primaryRegion:SecretListEntry'
, secretListEntry_primaryRegion
- The Region where Secrets Manager originated the secret.
$sel:arn:SecretListEntry'
, secretListEntry_arn
- The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
$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:rotationRules:SecretListEntry'
, secretListEntry_rotationRules
- A structure that defines the rotation configuration for the secret.
$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:rotationEnabled:SecretListEntry'
, secretListEntry_rotationEnabled
- Indicates whether automatic, scheduled rotation is enabled for this
secret.
$sel:createdDate:SecretListEntry'
, secretListEntry_createdDate
- The date and time when a secret was created.
$sel:kmsKeyId:SecretListEntry'
, secretListEntry_kmsKeyId
- The ARN or alias of the Amazon Web Services KMS customer master key
(CMK) used to encrypt the SecretString
and SecretBinary
fields in
each version of the secret. If you don't provide a key, then Secrets
Manager defaults to encrypting the secret fields with the default KMS
CMK, the key named awssecretsmanager
, for this account.
$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:owningService:SecretListEntry'
, secretListEntry_owningService
- Returns the name of the service that created the secret.
$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:lastAccessedDate:SecretListEntry'
, secretListEntry_lastAccessedDate
- The last date that this secret was accessed. This value is truncated to
midnight of the date and therefore shows only the date, not the time.
$sel:description:SecretListEntry'
, secretListEntry_description
- The user-provided description of the 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: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.
SecretVersionsListEntry' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe [Text]) (Maybe POSIX) |
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: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.
$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.
Tag
A structure that contains information about a tag.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SecretsManager.Types.Tag" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") '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:value:Tag'
, tag_value
- The string value associated with the key of the tag.
$sel:key:Tag'
, tag_key
- The key identifier, or name, of the tag.
ValidationErrorsEntry
data ValidationErrorsEntry Source #
Displays errors that occurred during validation of the resource policy.
See: newValidationErrorsEntry
smart constructor.
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.