libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecretsManager

Description

Derived from API version 2017-10-17 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Web Services Secrets Manager

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.

API Version

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

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

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

Instances details
Eq ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Read ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Show ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Generic ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Associated Types

type Rep ValidateResourcePolicy :: Type -> Type #

NFData ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Methods

rnf :: ValidateResourcePolicy -> () #

Hashable ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

ToJSON ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

AWSRequest ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Associated Types

type AWSResponse ValidateResourcePolicy #

ToHeaders ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

ToPath ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

ToQuery ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

type Rep ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

type Rep ValidateResourcePolicy = D1 ('MetaData "ValidateResourcePolicy" "Amazonka.SecretsManager.ValidateResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ValidateResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ValidateResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

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

Instances details
Eq ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Read ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Show ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Generic ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

Associated Types

type Rep ValidateResourcePolicyResponse :: Type -> Type #

NFData ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

type Rep ValidateResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ValidateResourcePolicy

type Rep ValidateResourcePolicyResponse = D1 ('MetaData "ValidateResourcePolicyResponse" "Amazonka.SecretsManager.ValidateResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ValidateResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "validationErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ValidationErrorsEntry])) :*: (S1 ('MetaSel ('Just "policyValidationPassed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Read DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Show DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Generic DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecret :: Type -> Type #

NFData DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecret -> () #

Hashable DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

ToJSON DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

AWSRequest DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type AWSResponse DeleteSecret #

ToHeaders DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

ToPath DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

ToQuery DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

type Rep DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

type Rep DeleteSecret = D1 ('MetaData "DeleteSecret" "Amazonka.SecretsManager.DeleteSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DeleteSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recoveryWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "forceDeleteWithoutRecovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

newDeleteSecret Source #

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

Instances details
Eq DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Read DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Show DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Generic DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecretResponse :: Type -> Type #

NFData DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecretResponse -> () #

type Rep DeleteSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteSecret

type Rep DeleteSecretResponse = D1 ('MetaData "DeleteSecretResponse" "Amazonka.SecretsManager.DeleteSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DeleteSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Instances

Instances details
Eq ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Read ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Show ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Generic ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Associated Types

type Rep ListSecrets :: Type -> Type #

NFData ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Methods

rnf :: ListSecrets -> () #

Hashable ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

ToJSON ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

AWSPager ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

AWSRequest ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Associated Types

type AWSResponse ListSecrets #

ToHeaders ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Methods

toHeaders :: ListSecrets -> [Header] #

ToPath ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

ToQuery ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

type Rep ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

type Rep ListSecrets = D1 ('MetaData "ListSecrets" "Amazonka.SecretsManager.ListSecrets" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ListSecrets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrderType)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListSecrets Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

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

Instances details
Eq ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Read ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Show ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Generic ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Associated Types

type Rep ListSecretsResponse :: Type -> Type #

NFData ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

Methods

rnf :: ListSecretsResponse -> () #

type Rep ListSecretsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecrets

type Rep ListSecretsResponse = D1 ('MetaData "ListSecretsResponse" "Amazonka.SecretsManager.ListSecrets" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ListSecretsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "secretList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecretListEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Instances

Instances details
Eq UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Show UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Generic UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Associated Types

type Rep UpdateSecret :: Type -> Type #

NFData UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Methods

rnf :: UpdateSecret -> () #

Hashable UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

ToJSON UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

AWSRequest UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Associated Types

type AWSResponse UpdateSecret #

ToHeaders UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

ToPath UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

ToQuery UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

type Rep UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

type Rep UpdateSecret = D1 ('MetaData "UpdateSecret" "Amazonka.SecretsManager.UpdateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UpdateSecret'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "secretBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

newUpdateSecret Source #

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 and SecretBinary 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 and SecretBinary 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

Instances details
Eq UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Read UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Show UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Generic UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Associated Types

type Rep UpdateSecretResponse :: Type -> Type #

NFData UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

Methods

rnf :: UpdateSecretResponse -> () #

type Rep UpdateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecret

type Rep UpdateSecretResponse = D1 ('MetaData "UpdateSecretResponse" "Amazonka.SecretsManager.UpdateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UpdateSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Read RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Show RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Generic RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Associated Types

type Rep RemoveRegionsFromReplication :: Type -> Type #

NFData RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Hashable RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

ToJSON RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

AWSRequest RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

ToHeaders RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

ToPath RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

ToQuery RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type Rep RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type Rep RemoveRegionsFromReplication = D1 ('MetaData "RemoveRegionsFromReplication" "Amazonka.SecretsManager.RemoveRegionsFromReplication" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RemoveRegionsFromReplication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "removeReplicaRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))
type AWSResponse RemoveRegionsFromReplication Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

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 #

Instances

Instances details
Eq RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Read RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Show RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Generic RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

NFData RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type Rep RemoveRegionsFromReplicationResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type Rep RemoveRegionsFromReplicationResponse = D1 ('MetaData "RemoveRegionsFromReplicationResponse" "Amazonka.SecretsManager.RemoveRegionsFromReplication" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RemoveRegionsFromReplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationStatusType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Read RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Show RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Generic RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Associated Types

type Rep RotateSecret :: Type -> Type #

NFData RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Methods

rnf :: RotateSecret -> () #

Hashable RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

ToJSON RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

AWSRequest RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Associated Types

type AWSResponse RotateSecret #

ToHeaders RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

ToPath RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

ToQuery RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

type Rep RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

type Rep RotateSecret = D1 ('MetaData "RotateSecret" "Amazonka.SecretsManager.RotateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RotateSecret'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rotationRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RotationRulesType)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rotationLambdaARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

newRotateSecret Source #

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

Instances details
Eq RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Read RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Show RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Generic RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Associated Types

type Rep RotateSecretResponse :: Type -> Type #

NFData RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

Methods

rnf :: RotateSecretResponse -> () #

type Rep RotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RotateSecret

type Rep RotateSecretResponse = D1 ('MetaData "RotateSecretResponse" "Amazonka.SecretsManager.RotateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RotateSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Instances

Instances details
Eq CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Show CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Generic CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Associated Types

type Rep CreateSecret :: Type -> Type #

NFData CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Methods

rnf :: CreateSecret -> () #

Hashable CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

ToJSON CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

AWSRequest CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Associated Types

type AWSResponse CreateSecret #

ToHeaders CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

ToPath CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

ToQuery CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

type Rep CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

type AWSResponse CreateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

newCreateSecret Source #

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 and SecretBinary 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 and SecretBinary 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 an Access 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

Instances details
Eq CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Read CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Show CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Generic CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Associated Types

type Rep CreateSecretResponse :: Type -> Type #

NFData CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

Methods

rnf :: CreateSecretResponse -> () #

type Rep CreateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CreateSecret

type Rep CreateSecretResponse = D1 ('MetaData "CreateSecretResponse" "Amazonka.SecretsManager.CreateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "CreateSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationStatusType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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

Instances details
Eq GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Read GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Show GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Generic GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Associated Types

type Rep GetSecretValue :: Type -> Type #

NFData GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Methods

rnf :: GetSecretValue -> () #

Hashable GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

ToJSON GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

AWSRequest GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Associated Types

type AWSResponse GetSecretValue #

ToHeaders GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

ToPath GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

ToQuery GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

type Rep GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

type Rep GetSecretValue = D1 ('MetaData "GetSecretValue" "Amazonka.SecretsManager.GetSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetSecretValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versionStage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

newGetSecretValue Source #

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.

Instances

Instances details
Eq GetSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Show GetSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Generic GetSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Associated Types

type Rep GetSecretValueResponse :: Type -> Type #

NFData GetSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

Methods

rnf :: GetSecretValueResponse -> () #

type Rep GetSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetSecretValue

type Rep GetSecretValueResponse = D1 ('MetaData "GetSecretValueResponse" "Amazonka.SecretsManager.GetSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetSecretValueResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "secretBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))))) :*: ((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "secretString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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.

Constructors

DescribeSecret' Text 

Instances

Instances details
Eq DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Read DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Show DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Generic DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Associated Types

type Rep DescribeSecret :: Type -> Type #

NFData DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Methods

rnf :: DescribeSecret -> () #

Hashable DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

ToJSON DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

AWSRequest DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Associated Types

type AWSResponse DescribeSecret #

ToHeaders DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

ToPath DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

ToQuery DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

type Rep DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

type Rep DescribeSecret = D1 ('MetaData "DescribeSecret" "Amazonka.SecretsManager.DescribeSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DescribeSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

newDescribeSecret Source #

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.

Instances

Instances details
Eq DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Read DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Show DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Generic DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Associated Types

type Rep DescribeSecretResponse :: Type -> Type #

NFData DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

Methods

rnf :: DescribeSecretResponse -> () #

type Rep DescribeSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DescribeSecret

type Rep DescribeSecretResponse = D1 ('MetaData "DescribeSecretResponse" "Amazonka.SecretsManager.DescribeSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DescribeSecretResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "lastChangedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "primaryRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rotationRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RotationRulesType)))) :*: ((S1 ('MetaSel ('Just "deletedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "rotationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "versionIdsToStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (NonEmpty Text)))) :*: S1 ('MetaSel ('Just "replicationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationStatusType]))) :*: (S1 ('MetaSel ('Just "owningService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastRotatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rotationLambdaARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

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.

Constructors

RestoreSecret' Text 

Instances

Instances details
Eq RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Read RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Show RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Generic RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type Rep RestoreSecret :: Type -> Type #

NFData RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

rnf :: RestoreSecret -> () #

Hashable RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

ToJSON RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

AWSRequest RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type AWSResponse RestoreSecret #

ToHeaders RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

ToPath RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

ToQuery RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

type Rep RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

type Rep RestoreSecret = D1 ('MetaData "RestoreSecret" "Amazonka.SecretsManager.RestoreSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RestoreSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RestoreSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

newRestoreSecret Source #

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

Instances details
Eq RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Read RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Show RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Generic RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type Rep RestoreSecretResponse :: Type -> Type #

NFData RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

rnf :: RestoreSecretResponse -> () #

type Rep RestoreSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.RestoreSecret

type Rep RestoreSecretResponse = D1 ('MetaData "RestoreSecretResponse" "Amazonka.SecretsManager.RestoreSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RestoreSecretResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Read CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Show CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Generic CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type Rep CancelRotateSecret :: Type -> Type #

NFData CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

rnf :: CancelRotateSecret -> () #

Hashable CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

ToJSON CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

AWSRequest CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type AWSResponse CancelRotateSecret #

ToHeaders CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

ToPath CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

ToQuery CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecret = D1 ('MetaData "CancelRotateSecret" "Amazonka.SecretsManager.CancelRotateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "CancelRotateSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelRotateSecret Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

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

Instances details
Eq CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Read CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Show CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Generic CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type Rep CancelRotateSecretResponse :: Type -> Type #

NFData CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecretResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecretResponse = D1 ('MetaData "CancelRotateSecretResponse" "Amazonka.SecretsManager.CancelRotateSecret" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "CancelRotateSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Constructors

GetResourcePolicy' Text 

Instances

Instances details
Eq GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Read GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Show GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Generic GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Associated Types

type Rep GetResourcePolicy :: Type -> Type #

NFData GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Methods

rnf :: GetResourcePolicy -> () #

Hashable GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

ToJSON GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

AWSRequest GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Associated Types

type AWSResponse GetResourcePolicy #

ToHeaders GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

ToPath GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

ToQuery GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

type Rep GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

type Rep GetResourcePolicy = D1 ('MetaData "GetResourcePolicy" "Amazonka.SecretsManager.GetResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

newGetResourcePolicy Source #

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

Instances details
Eq GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Read GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Show GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Generic GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

Associated Types

type Rep GetResourcePolicyResponse :: Type -> Type #

NFData GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

type Rep GetResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetResourcePolicy

type Rep GetResourcePolicyResponse = D1 ('MetaData "GetResourcePolicyResponse" "Amazonka.SecretsManager.GetResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetResourcePolicyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Instances

Instances details
Eq PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Show PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Generic PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type Rep PutSecretValue :: Type -> Type #

NFData PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

rnf :: PutSecretValue -> () #

Hashable PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

ToJSON PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

AWSRequest PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type AWSResponse PutSecretValue #

ToHeaders PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

ToPath PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

ToQuery PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

type Rep PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

type Rep PutSecretValue = D1 ('MetaData "PutSecretValue" "Amazonka.SecretsManager.PutSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutSecretValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "secretBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64)))) :*: (S1 ('MetaSel ('Just "secretString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutSecretValue Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

newPutSecretValue Source #

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 or SecretBinary 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 and SecretBinary 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

Instances details
Eq PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Read PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Show PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Generic PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type Rep PutSecretValueResponse :: Type -> Type #

NFData PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

rnf :: PutSecretValueResponse -> () #

type Rep PutSecretValueResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutSecretValue

type Rep PutSecretValueResponse = D1 ('MetaData "PutSecretValueResponse" "Amazonka.SecretsManager.PutSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutSecretValueResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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

Instances details
Eq ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Read ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Show ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Generic ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Associated Types

type Rep ReplicateSecretToRegions :: Type -> Type #

NFData ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Hashable ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

ToJSON ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

AWSRequest ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

ToHeaders ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

ToPath ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

ToQuery ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegions = D1 ('MetaData "ReplicateSecretToRegions" "Amazonka.SecretsManager.ReplicateSecretToRegions" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicateSecretToRegions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceOverwriteReplicaSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "addReplicaRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ReplicaRegionType)))))
type AWSResponse ReplicateSecretToRegions Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

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

Instances details
Eq ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Read ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Show ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Generic ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Associated Types

type Rep ReplicateSecretToRegionsResponse :: Type -> Type #

NFData ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegionsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegionsResponse = D1 ('MetaData "ReplicateSecretToRegionsResponse" "Amazonka.SecretsManager.ReplicateSecretToRegions" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicateSecretToRegionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationStatusType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Read StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Show StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Generic StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Associated Types

type Rep StopReplicationToReplica :: Type -> Type #

NFData StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Hashable StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

ToJSON StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

AWSRequest StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

ToHeaders StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

ToPath StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

ToQuery StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

type Rep StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

type Rep StopReplicationToReplica = D1 ('MetaData "StopReplicationToReplica" "Amazonka.SecretsManager.StopReplicationToReplica" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "StopReplicationToReplica'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopReplicationToReplica Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

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

Instances details
Eq StopReplicationToReplicaResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Read StopReplicationToReplicaResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Show StopReplicationToReplicaResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Generic StopReplicationToReplicaResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

Associated Types

type Rep StopReplicationToReplicaResponse :: Type -> Type #

NFData StopReplicationToReplicaResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.StopReplicationToReplica

type Rep StopReplicationToReplicaResponse Source # 
Instance details

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.

Instances

Instances details
Eq GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Read GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Show GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Generic GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type Rep GetRandomPassword :: Type -> Type #

NFData GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

rnf :: GetRandomPassword -> () #

Hashable GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

ToJSON GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

AWSRequest GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type AWSResponse GetRandomPassword #

ToHeaders GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

ToPath GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

ToQuery GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPassword = D1 ('MetaData "GetRandomPassword" "Amazonka.SecretsManager.GetRandomPassword" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetRandomPassword'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeSpace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "excludeNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeLowercase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "excludeCharacters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "excludePunctuation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "requireEachIncludedType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeUppercase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "passwordLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse GetRandomPassword Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

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

Instances details
Eq GetRandomPasswordResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Show GetRandomPasswordResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Generic GetRandomPasswordResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type Rep GetRandomPasswordResponse :: Type -> Type #

NFData GetRandomPasswordResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPasswordResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPasswordResponse = D1 ('MetaData "GetRandomPasswordResponse" "Amazonka.SecretsManager.GetRandomPassword" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "GetRandomPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "randomPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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

Instances details
Eq ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Read ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Show ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Generic ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Associated Types

type Rep ListSecretVersionIds :: Type -> Type #

NFData ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Methods

rnf :: ListSecretVersionIds -> () #

Hashable ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

ToJSON ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

AWSPager ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

AWSRequest ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Associated Types

type AWSResponse ListSecretVersionIds #

ToHeaders ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

ToPath ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

ToQuery ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

type Rep ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

type Rep ListSecretVersionIds = D1 ('MetaData "ListSecretVersionIds" "Amazonka.SecretsManager.ListSecretVersionIds" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ListSecretVersionIds'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "includeDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListSecretVersionIds Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

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.

Instances

Instances details
Eq ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Read ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Show ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Generic ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

Associated Types

type Rep ListSecretVersionIdsResponse :: Type -> Type #

NFData ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

type Rep ListSecretVersionIdsResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.ListSecretVersionIds

type Rep ListSecretVersionIdsResponse = D1 ('MetaData "ListSecretVersionIdsResponse" "Amazonka.SecretsManager.ListSecretVersionIds" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ListSecretVersionIdsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecretVersionsListEntry]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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.

Constructors

TagResource' Text [Tag] 

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

ToJSON TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.SecretsManager.TagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))
type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

newTagResource Source #

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.

Constructors

TagResourceResponse' 

Instances

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.SecretsManager.TagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances details
Eq PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Read PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Show PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Generic PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Associated Types

type Rep PutResourcePolicy :: Type -> Type #

NFData PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Methods

rnf :: PutResourcePolicy -> () #

Hashable PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

ToJSON PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

AWSRequest PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Associated Types

type AWSResponse PutResourcePolicy #

ToHeaders PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

ToPath PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

ToQuery PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

type Rep PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

type Rep PutResourcePolicy = D1 ('MetaData "PutResourcePolicy" "Amazonka.SecretsManager.PutResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockPublicPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse PutResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

newPutResourcePolicy Source #

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

Instances details
Eq PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Read PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Show PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Generic PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

Associated Types

type Rep PutResourcePolicyResponse :: Type -> Type #

NFData PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

type Rep PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.PutResourcePolicy

type Rep PutResourcePolicyResponse = D1 ('MetaData "PutResourcePolicyResponse" "Amazonka.SecretsManager.PutResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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

Instances details
Eq DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Read DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Show DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Generic DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Associated Types

type Rep DeleteResourcePolicy :: Type -> Type #

NFData DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Methods

rnf :: DeleteResourcePolicy -> () #

Hashable DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

ToJSON DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

AWSRequest DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Associated Types

type AWSResponse DeleteResourcePolicy #

ToHeaders DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

ToPath DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

ToQuery DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

type Rep DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

type Rep DeleteResourcePolicy = D1 ('MetaData "DeleteResourcePolicy" "Amazonka.SecretsManager.DeleteResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DeleteResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteResourcePolicy Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

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

Instances details
Eq DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Read DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Show DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Generic DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

Associated Types

type Rep DeleteResourcePolicyResponse :: Type -> Type #

NFData DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

type Rep DeleteResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.DeleteResourcePolicy

type Rep DeleteResourcePolicyResponse = D1 ('MetaData "DeleteResourcePolicyResponse" "Amazonka.SecretsManager.DeleteResourcePolicy" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "DeleteResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.

Constructors

UntagResource' Text [Text] 

Instances

Instances details
Eq UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Read UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Generic UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

NFData UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Methods

rnf :: UntagResource -> () #

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type AWSResponse UntagResource #

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.SecretsManager.UntagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

newUntagResource Source #

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

Instances details
Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.SecretsManager.UntagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances details
Eq UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Read UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Show UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Generic UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Associated Types

type Rep UpdateSecretVersionStage :: Type -> Type #

NFData UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Hashable UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

ToJSON UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

AWSRequest UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

ToHeaders UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

ToPath UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

ToQuery UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

type Rep UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

type Rep UpdateSecretVersionStage = D1 ('MetaData "UpdateSecretVersionStage" "Amazonka.SecretsManager.UpdateSecretVersionStage" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UpdateSecretVersionStage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "removeFromVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "moveToVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "versionStage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateSecretVersionStage Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

newUpdateSecretVersionStage Source #

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

Instances details
Eq UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Read UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Show UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Generic UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

Associated Types

type Rep UpdateSecretVersionStageResponse :: Type -> Type #

NFData UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

type Rep UpdateSecretVersionStageResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UpdateSecretVersionStage

type Rep UpdateSecretVersionStageResponse = D1 ('MetaData "UpdateSecretVersionStageResponse" "Amazonka.SecretsManager.UpdateSecretVersionStage" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UpdateSecretVersionStageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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 #

Instances

Instances details
Eq FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Ord FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Read FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Show FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Generic FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Associated Types

type Rep FilterNameStringType :: Type -> Type #

NFData FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Methods

rnf :: FilterNameStringType -> () #

Hashable FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToJSON FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToJSONKey FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromJSON FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromJSONKey FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToLog FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToHeader FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToQuery FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromXML FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToXML FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToByteString FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromText FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToText FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

type Rep FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

type Rep FilterNameStringType = D1 ('MetaData "FilterNameStringType" "Amazonka.SecretsManager.Types.FilterNameStringType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "FilterNameStringType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFilterNameStringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SortOrderType

newtype SortOrderType Source #

Constructors

SortOrderType' 

Bundled Patterns

pattern SortOrderType_Asc :: SortOrderType 
pattern SortOrderType_Desc :: SortOrderType 

Instances

Instances details
Eq SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Ord SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Read SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Show SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Generic SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Associated Types

type Rep SortOrderType :: Type -> Type #

NFData SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

rnf :: SortOrderType -> () #

Hashable SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToJSON SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToJSONKey SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromJSON SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromJSONKey SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToLog SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToHeader SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToQuery SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromXML SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToXML SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

toXML :: SortOrderType -> XML #

ToByteString SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromText SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToText SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

toText :: SortOrderType -> Text #

type Rep SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

type Rep SortOrderType = D1 ('MetaData "SortOrderType" "Amazonka.SecretsManager.Types.SortOrderType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "SortOrderType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSortOrderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StatusType

newtype StatusType Source #

Constructors

StatusType' 

Fields

Bundled Patterns

pattern StatusType_Failed :: StatusType 
pattern StatusType_InProgress :: StatusType 
pattern StatusType_InSync :: StatusType 

Instances

Instances details
Eq StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Ord StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Read StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Show StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Generic StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Associated Types

type Rep StatusType :: Type -> Type #

NFData StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

rnf :: StatusType -> () #

Hashable StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToJSON StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToJSONKey StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromJSON StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromJSONKey StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToLog StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToHeader StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToQuery StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromXML StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToXML StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

toXML :: StatusType -> XML #

ToByteString StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromText StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToText StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

toText :: StatusType -> Text #

type Rep StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

type Rep StatusType = D1 ('MetaData "StatusType" "Amazonka.SecretsManager.Types.StatusType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "StatusType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStatusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Filter

data Filter Source #

Allows you to add filters when you use the search function in Secrets Manager.

See: newFilter smart constructor.

Instances

Instances details
Eq Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Read Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Show Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Generic Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Associated Types

type Rep Filter :: Type -> Type #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

NFData Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

rnf :: Filter -> () #

Hashable Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

ToJSON Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

type Rep Filter Source # 
Instance details

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))))

newFilter :: Filter Source #

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

Instances details
Eq ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Read ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Show ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Generic ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Associated Types

type Rep ReplicaRegionType :: Type -> Type #

NFData ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Methods

rnf :: ReplicaRegionType -> () #

Hashable ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

ToJSON ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

type Rep ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

type Rep ReplicaRegionType = D1 ('MetaData "ReplicaRegionType" "Amazonka.SecretsManager.Types.ReplicaRegionType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicaRegionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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

Instances details
Eq ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Read ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Show ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Generic ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Associated Types

type Rep ReplicationStatusType :: Type -> Type #

NFData ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Methods

rnf :: ReplicationStatusType -> () #

Hashable ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

FromJSON ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

type Rep ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

type Rep ReplicationStatusType = D1 ('MetaData "ReplicationStatusType" "Amazonka.SecretsManager.Types.ReplicationStatusType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicationStatusType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusType)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

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

Instances details
Eq RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Read RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Show RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Generic RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Associated Types

type Rep RotationRulesType :: Type -> Type #

NFData RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

rnf :: RotationRulesType -> () #

Hashable RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

ToJSON RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

FromJSON RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

type Rep RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

type Rep RotationRulesType = D1 ('MetaData "RotationRulesType" "Amazonka.SecretsManager.Types.RotationRulesType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RotationRulesType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "automaticallyAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

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.

Instances

Instances details
Eq SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Read SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Show SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Generic SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Associated Types

type Rep SecretListEntry :: Type -> Type #

NFData SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

rnf :: SecretListEntry -> () #

Hashable SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

FromJSON SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

type Rep SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

type Rep SecretListEntry = D1 ('MetaData "SecretListEntry" "Amazonka.SecretsManager.Types.SecretListEntry" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "SecretListEntry'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "lastChangedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "primaryRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretVersionsToStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (NonEmpty Text)))))) :*: ((S1 ('MetaSel ('Just "rotationRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RotationRulesType)) :*: S1 ('MetaSel ('Just "deletedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "rotationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "owningService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastRotatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rotationLambdaARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

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.

Instances

Instances details
Eq SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Read SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Show SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Generic SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Associated Types

type Rep SecretVersionsListEntry :: Type -> Type #

NFData SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Methods

rnf :: SecretVersionsListEntry -> () #

Hashable SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

FromJSON SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

type Rep SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

type Rep SecretVersionsListEntry = D1 ('MetaData "SecretVersionsListEntry" "Amazonka.SecretsManager.Types.SecretVersionsListEntry" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "SecretVersionsListEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "kmsKeyIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

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

data Tag Source #

A structure that contains information about a tag.

See: newTag smart constructor.

Constructors

Tag' (Maybe Text) (Maybe Text) 

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

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

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

Read Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

NFData Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

rnf :: Tag -> () #

Hashable Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

FromJSON Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

type Rep Tag Source # 
Instance details

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))))

newTag :: Tag Source #

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

Instances details
Eq ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Read ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Show ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Generic ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Associated Types

type Rep ValidationErrorsEntry :: Type -> Type #

NFData ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Methods

rnf :: ValidationErrorsEntry -> () #

Hashable ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

FromJSON ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

type Rep ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

type Rep ValidationErrorsEntry = D1 ('MetaData "ValidationErrorsEntry" "Amazonka.SecretsManager.Types.ValidationErrorsEntry" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ValidationErrorsEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.