Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DecryptionFailure

type DecryptionFailure struct {
	Message *string
}

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

    func (*DecryptionFailure) Error

    func (e *DecryptionFailure) Error() string

    func (*DecryptionFailure) ErrorCode

    func (e *DecryptionFailure) ErrorCode() string

    func (*DecryptionFailure) ErrorFault

    func (e *DecryptionFailure) ErrorFault() smithy.ErrorFault

    func (*DecryptionFailure) ErrorMessage

    func (e *DecryptionFailure) ErrorMessage() string

    type EncryptionFailure

    type EncryptionFailure struct {
    	Message *string
    }

      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 (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html).

      func (*EncryptionFailure) Error

      func (e *EncryptionFailure) Error() string

      func (*EncryptionFailure) ErrorCode

      func (e *EncryptionFailure) ErrorCode() string

      func (*EncryptionFailure) ErrorFault

      func (e *EncryptionFailure) ErrorFault() smithy.ErrorFault

      func (*EncryptionFailure) ErrorMessage

      func (e *EncryptionFailure) ErrorMessage() string

      type Filter

      type Filter struct {
      
      	// Filters your list of secrets by a specific key.
      	Key FilterNameStringType
      
      	// Filters your list of secrets by a specific value.
      	Values []string
      }

        Allows you to filter your list of secrets.

        type FilterNameStringType

        type FilterNameStringType string
        const (
        	FilterNameStringTypeDescription FilterNameStringType = "description"
        	FilterNameStringTypeName        FilterNameStringType = "name"
        	FilterNameStringTypeTagKey      FilterNameStringType = "tag-key"
        	FilterNameStringTypeTagValue    FilterNameStringType = "tag-value"
        	FilterNameStringTypeAll         FilterNameStringType = "all"
        )

          Enum values for FilterNameStringType

          func (FilterNameStringType) Values

            Values returns all known values for FilterNameStringType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

            type InternalServiceError

            type InternalServiceError struct {
            	Message *string
            }

              An error occurred on the server side.

              func (*InternalServiceError) Error

              func (e *InternalServiceError) Error() string

              func (*InternalServiceError) ErrorCode

              func (e *InternalServiceError) ErrorCode() string

              func (*InternalServiceError) ErrorFault

              func (e *InternalServiceError) ErrorFault() smithy.ErrorFault

              func (*InternalServiceError) ErrorMessage

              func (e *InternalServiceError) ErrorMessage() string

              type InvalidNextTokenException

              type InvalidNextTokenException struct {
              	Message *string
              }

                You provided an invalid NextToken value.

                func (*InvalidNextTokenException) Error

                func (e *InvalidNextTokenException) Error() string

                func (*InvalidNextTokenException) ErrorCode

                func (e *InvalidNextTokenException) ErrorCode() string

                func (*InvalidNextTokenException) ErrorFault

                func (*InvalidNextTokenException) ErrorMessage

                func (e *InvalidNextTokenException) ErrorMessage() string

                type InvalidParameterException

                type InvalidParameterException struct {
                	Message *string
                }

                  You provided an invalid value for a parameter.

                  func (*InvalidParameterException) Error

                  func (e *InvalidParameterException) Error() string

                  func (*InvalidParameterException) ErrorCode

                  func (e *InvalidParameterException) ErrorCode() string

                  func (*InvalidParameterException) ErrorFault

                  func (*InvalidParameterException) ErrorMessage

                  func (e *InvalidParameterException) ErrorMessage() string

                  type InvalidRequestException

                  type InvalidRequestException struct {
                  	Message *string
                  }

                    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.

                    func (*InvalidRequestException) Error

                    func (e *InvalidRequestException) Error() string

                    func (*InvalidRequestException) ErrorCode

                    func (e *InvalidRequestException) ErrorCode() string

                    func (*InvalidRequestException) ErrorFault

                    func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

                    func (*InvalidRequestException) ErrorMessage

                    func (e *InvalidRequestException) ErrorMessage() string

                    type LimitExceededException

                    type LimitExceededException struct {
                    	Message *string
                    }

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

                      func (*LimitExceededException) Error

                      func (e *LimitExceededException) Error() string

                      func (*LimitExceededException) ErrorCode

                      func (e *LimitExceededException) ErrorCode() string

                      func (*LimitExceededException) ErrorFault

                      func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

                      func (*LimitExceededException) ErrorMessage

                      func (e *LimitExceededException) ErrorMessage() string

                      type MalformedPolicyDocumentException

                      type MalformedPolicyDocumentException struct {
                      	Message *string
                      }

                        The policy document that you provided isn't valid.

                        func (*MalformedPolicyDocumentException) Error

                        func (*MalformedPolicyDocumentException) ErrorCode

                        func (*MalformedPolicyDocumentException) ErrorFault

                        func (*MalformedPolicyDocumentException) ErrorMessage

                        func (e *MalformedPolicyDocumentException) ErrorMessage() string

                        type PreconditionNotMetException

                        type PreconditionNotMetException struct {
                        	Message *string
                        }

                          The request failed because you did not complete all the prerequisite steps.

                          func (*PreconditionNotMetException) Error

                          func (*PreconditionNotMetException) ErrorCode

                          func (e *PreconditionNotMetException) ErrorCode() string

                          func (*PreconditionNotMetException) ErrorFault

                          func (*PreconditionNotMetException) ErrorMessage

                          func (e *PreconditionNotMetException) ErrorMessage() string

                          type PublicPolicyException

                          type PublicPolicyException struct {
                          	Message *string
                          }

                            The resource policy did not prevent broad access to the secret.

                            func (*PublicPolicyException) Error

                            func (e *PublicPolicyException) Error() string

                            func (*PublicPolicyException) ErrorCode

                            func (e *PublicPolicyException) ErrorCode() string

                            func (*PublicPolicyException) ErrorFault

                            func (e *PublicPolicyException) ErrorFault() smithy.ErrorFault

                            func (*PublicPolicyException) ErrorMessage

                            func (e *PublicPolicyException) ErrorMessage() string

                            type ResourceExistsException

                            type ResourceExistsException struct {
                            	Message *string
                            }

                              A resource with the ID you requested already exists.

                              func (*ResourceExistsException) Error

                              func (e *ResourceExistsException) Error() string

                              func (*ResourceExistsException) ErrorCode

                              func (e *ResourceExistsException) ErrorCode() string

                              func (*ResourceExistsException) ErrorFault

                              func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault

                              func (*ResourceExistsException) ErrorMessage

                              func (e *ResourceExistsException) ErrorMessage() string

                              type ResourceNotFoundException

                              type ResourceNotFoundException struct {
                              	Message *string
                              }

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

                                func (*ResourceNotFoundException) Error

                                func (e *ResourceNotFoundException) Error() string

                                func (*ResourceNotFoundException) ErrorCode

                                func (e *ResourceNotFoundException) ErrorCode() string

                                func (*ResourceNotFoundException) ErrorFault

                                func (*ResourceNotFoundException) ErrorMessage

                                func (e *ResourceNotFoundException) ErrorMessage() string

                                type RotationRulesType

                                type RotationRulesType struct {
                                
                                	// 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.
                                	AutomaticallyAfterDays int64
                                }

                                  A structure that defines the rotation configuration for the secret.

                                  type SecretListEntry

                                  type SecretListEntry struct {
                                  
                                  	// The Amazon Resource Name (ARN) of the secret. For more information about ARNs in
                                  	// Secrets Manager, see Policy Resources
                                  	// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources)
                                  	// in the AWS Secrets Manager User Guide.
                                  	ARN *string
                                  
                                  	// The date and time when a secret was created.
                                  	CreatedDate *time.Time
                                  
                                  	// 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.
                                  	DeletedDate *time.Time
                                  
                                  	// The user-provided description of the secret.
                                  	Description *string
                                  
                                  	// The ARN or alias of the AWS 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.
                                  	KmsKeyId *string
                                  
                                  	// 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.
                                  	LastAccessedDate *time.Time
                                  
                                  	// The last date and time that this secret was modified in any way.
                                  	LastChangedDate *time.Time
                                  
                                  	// The last date and time that the rotation process for this secret was invoked.
                                  	LastRotatedDate *time.Time
                                  
                                  	// 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.
                                  	Name *string
                                  
                                  	// Returns the name of the service that created the secret.
                                  	OwningService *string
                                  
                                  	// Indicates whether automatic, scheduled rotation is enabled for this secret.
                                  	RotationEnabled bool
                                  
                                  	// The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and
                                  	// expire the secret either automatically per the schedule or manually by a call to
                                  	// RotateSecret.
                                  	RotationLambdaARN *string
                                  
                                  	// A structure that defines the rotation configuration for the secret.
                                  	RotationRules *RotationRulesType
                                  
                                  	// 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.
                                  	SecretVersionsToStages map[string][]string
                                  
                                  	// The list of user-defined tags associated with the secret. To add tags to a
                                  	// secret, use TagResource. To remove tags, use UntagResource.
                                  	Tags []Tag
                                  }

                                    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.

                                    type SecretVersionsListEntry

                                    type SecretVersionsListEntry struct {
                                    
                                    	// The date and time this version of the secret was created.
                                    	CreatedDate *time.Time
                                    
                                    	// 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.
                                    	LastAccessedDate *time.Time
                                    
                                    	// The unique version identifier of this version of the secret.
                                    	VersionId *string
                                    
                                    	// An array of staging labels that are currently associated with this version of
                                    	// the secret.
                                    	VersionStages []string
                                    }

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

                                      type SortOrderType

                                      type SortOrderType string
                                      const (
                                      	SortOrderTypeAsc  SortOrderType = "asc"
                                      	SortOrderTypeDesc SortOrderType = "desc"
                                      )

                                        Enum values for SortOrderType

                                        func (SortOrderType) Values

                                        func (SortOrderType) Values() []SortOrderType

                                          Values returns all known values for SortOrderType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                          type Tag

                                          type Tag struct {
                                          
                                          	// The key identifier, or name, of the tag.
                                          	Key *string
                                          
                                          	// The string value associated with the key of the tag.
                                          	Value *string
                                          }

                                            A structure that contains information about a tag.

                                            type ValidationErrorsEntry

                                            type ValidationErrorsEntry struct {
                                            
                                            	// Checks the name of the policy.
                                            	CheckName *string
                                            
                                            	// Displays error messages if validation encounters problems during validation of
                                            	// the resource policy.
                                            	ErrorMessage *string
                                            }

                                              Displays errors that occurred during validation of the resource policy.