types

package
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIErrorType 

type APIErrorType struct {

	// The error Secrets Manager encountered while retrieving an individual secret as
	// part of BatchGetSecretValue, for example ResourceNotFoundException , InvalidParameterException ,
	// InvalidRequestException , DecryptionFailure , or AccessDeniedException .
	ErrorCode *string

	// A message describing the error.
	Message *string

	// The ARN or name of the secret.
	SecretId *string
	// contains filtered or unexported fields
}

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.

type DecryptionFailure 

type DecryptionFailure struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.

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 {

	// The following are keys you can use:
	//
	//   - description: Prefix match, not case-sensitive.
	//
	//   - name: Prefix match, case-sensitive.
	//
	//   - tag-key: Prefix match, case-sensitive.
	//
	//   - tag-value: Prefix match, case-sensitive.
	//
	//   - primary-region: Prefix match, case-sensitive.
	//
	//   - owning-service: Prefix match, case-sensitive.
	//
	//   - all: Breaks the filter value string into words and then searches all
	//   attributes for matches. Not case-sensitive.
	Key FilterNameStringType

	// The keyword to filter for.
	//
	// You can prefix your search value with an exclamation mark ( ! ) in order to
	// perform negation filters.
	Values []string
	// contains filtered or unexported fields
}

Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.

type FilterNameStringType 

type FilterNameStringType string
const (
	FilterNameStringTypeDescription   FilterNameStringType = "description"
	FilterNameStringTypeName          FilterNameStringType = "name"
	FilterNameStringTypeTagKey        FilterNameStringType = "tag-key"
	FilterNameStringTypeTagValue      FilterNameStringType = "tag-value"
	FilterNameStringTypePrimaryRegion FilterNameStringType = "primary-region"
	FilterNameStringTypeOwningService FilterNameStringType = "owning-service"
	FilterNameStringTypeAll           FilterNameStringType = "all"
)

Enum values for FilterNameStringType

func (FilterNameStringType) Values 

func (FilterNameStringType) Values() []FilterNameStringType

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The NextToken value is invalid.

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

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

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidParameterException 

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter name or value is invalid.

func (*InvalidParameterException) Error 

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode 

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault 

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

func (*InvalidParameterException) ErrorMessage 

func (e *InvalidParameterException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A parameter value is not valid for the current state of the resource.

Possible causes:

  • The secret is scheduled for deletion.

  • You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

  • The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource policy has syntax errors.

func (*MalformedPolicyDocumentException) Error 

func (e *MalformedPolicyDocumentException) Error() string

func (*MalformedPolicyDocumentException) ErrorCode 

func (e *MalformedPolicyDocumentException) ErrorCode() string

func (*MalformedPolicyDocumentException) ErrorFault 

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

func (*MalformedPolicyDocumentException) ErrorMessage 

func (e *MalformedPolicyDocumentException) ErrorMessage() string

type PreconditionNotMetException 

type PreconditionNotMetException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*PreconditionNotMetException) Error 

func (e *PreconditionNotMetException) Error() string

func (*PreconditionNotMetException) ErrorCode 

func (e *PreconditionNotMetException) ErrorCode() string

func (*PreconditionNotMetException) ErrorFault 

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

func (*PreconditionNotMetException) ErrorMessage 

func (e *PreconditionNotMetException) ErrorMessage() string

type PublicPolicyException 

type PublicPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The BlockPublicPolicy parameter is set to true, and 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 ReplicaRegionType 

type ReplicaRegionType struct {

	// The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't
	// include this field, Secrets Manager uses aws/secretsmanager .
	KmsKeyId *string

	// A Region code. For a list of Region codes, see [Name and code of Regions].
	//
	// [Name and code of Regions]: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
	Region *string
	// contains filtered or unexported fields
}

A custom type that specifies a Region and the KmsKeyId for a replica secret.

type ReplicationStatusType 

type ReplicationStatusType struct {

	// Can be an ARN , Key ID , or Alias .
	KmsKeyId *string

	// The date that the secret was last accessed in the Region. This field is omitted
	// if the secret has never been retrieved in the Region.
	LastAccessedDate *time.Time

	// The Region where replication occurs.
	Region *string

	// The status can be InProgress , Failed , or InSync .
	Status StatusType

	// Status message such as "Secret with this name already exists in this region".
	StatusMessage *string
	// contains filtered or unexported fields
}

A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.

type ResourceExistsException 

type ResourceExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Secrets Manager 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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RotationRulesType 

type RotationRulesType struct {

	// The number of days between rotations of the secret. You can use this value to
	// check that your secret meets your compliance guidelines for how often secrets
	// must be rotated. If you use this field to set the rotation schedule, Secrets
	// Manager calculates the next rotation date based on the previous rotation.
	// Manually updating the secret value by calling PutSecretValue or UpdateSecret is
	// considered a valid rotation.
	//
	// In DescribeSecret and ListSecrets , this value is calculated from the rotation
	// schedule after every successful rotation. In RotateSecret , you can set the
	// rotation schedule in RotationRules with AutomaticallyAfterDays or
	// ScheduleExpression , but not both. To set a rotation schedule in hours, use
	// ScheduleExpression .
	AutomaticallyAfterDays *int64

	// The length of the rotation window in hours, for example 3h for a three hour
	// window. Secrets Manager rotates your secret at any time during this window. The
	// window must not extend into the next rotation window or the next UTC day. The
	// window starts according to the ScheduleExpression . If you don't specify a
	// Duration , for a ScheduleExpression in hours, the window automatically closes
	// after one hour. For a ScheduleExpression in days, the window automatically
	// closes at the end of the UTC day. For more information, including examples, see [Schedule expressions in Secrets Manager rotation]
	// in the Secrets Manager Users Guide.
	//
	// [Schedule expressions in Secrets Manager rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html
	Duration *string

	// A cron() or rate() expression that defines the schedule for rotating your
	// secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager
	// rotates your secret any time during a rotation window.
	//
	// Secrets Manager rate() expressions represent the interval in hours or days that
	// you want to rotate your secret, for example rate(12 hours) or rate(10 days) .
	// You can rotate a secret as often as every four hours. If you use a rate()
	// expression, the rotation window starts at midnight. For a rate in hours, the
	// default rotation window closes after one hour. For a rate in days, the default
	// rotation window closes at the end of the day. You can set the Duration to
	// change the rotation window. The rotation window must not extend into the next
	// UTC day or into the next rotation window.
	//
	// You can use a cron() expression to create a rotation schedule that is more
	// detailed than a rotation interval. For more information, including examples, see
	// [Schedule expressions in Secrets Manager rotation]in the Secrets Manager Users Guide. For a cron expression that represents a
	// schedule in hours, the default rotation window closes after one hour. For a cron
	// expression that represents a schedule in days, the default rotation window
	// closes at the end of the day. You can set the Duration to change the rotation
	// window. The rotation window must not extend into the next UTC day or into the
	// next rotation window.
	//
	// [Schedule expressions in Secrets Manager rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html
	ScheduleExpression *string
	// contains filtered or unexported fields
}

A structure that defines the rotation configuration for the secret.

type SecretListEntry 

type SecretListEntry struct {

	// The Amazon Resource Name (ARN) of the secret.
	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]
	// DeleteSecret operation.
	//
	// [DeleteSecret]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html
	DeletedDate *time.Time

	// The user-provided description of the secret.
	Description *string

	// The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
	// If the secret is encrypted with the Amazon Web Services managed key
	// aws/secretsmanager , this field is omitted.
	KmsKeyId *string

	// The date that the secret was last accessed in the Region. This field is omitted
	// if the secret has never been retrieved in the Region.
	LastAccessedDate *time.Time

	// The last date and time that this secret was modified in any way.
	LastChangedDate *time.Time

	// 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.
	LastRotatedDate *time.Time

	// The friendly name of the secret.
	Name *string

	// The next rotation is scheduled to occur on or before this date. If the secret
	// isn't configured for rotation or rotation has been disabled, Secrets Manager
	// returns null.
	NextRotationDate *time.Time

	// Returns the name of the service that created the secret.
	OwningService *string

	// The Region where Secrets Manager originated the secret.
	PrimaryRegion *string

	// Indicates whether automatic, scheduled rotation is enabled for this secret.
	RotationEnabled *bool

	// 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]RotateSecret .
	//
	// [RotateSecret]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html
	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]TagResource . To remove tags, use [UntagResource]UntagResource .
	//
	// [TagResource]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html
	// [UntagResource]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html
	Tags []Tag
	// contains filtered or unexported fields
}

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .

type SecretValueEntry 

type SecretValueEntry struct {

	// The Amazon Resource Name (ARN) of the secret.
	ARN *string

	// The date the secret was created.
	CreatedDate *time.Time

	// The friendly name of the secret.
	Name *string

	// The decrypted secret value, if the secret value was originally provided as
	// binary data in the form of a byte array. The parameter represents the binary
	// data as a [base64-encoded]string.
	//
	// [base64-encoded]: https://tools.ietf.org/html/rfc4648#section-4
	SecretBinary []byte

	// The decrypted secret value, if the secret value was originally provided as a
	// string or through the Secrets Manager console.
	SecretString *string

	// The unique version identifier of this version of the secret.
	VersionId *string

	// A list of all of the staging labels currently attached to this version of the
	// secret.
	VersionStages []string
	// contains filtered or unexported fields
}

A structure that contains the secret value and other details for a secret.

type SecretVersionsListEntry 

type SecretVersionsListEntry struct {

	// The date and time this version of the secret was created.
	CreatedDate *time.Time

	// The KMS keys used to encrypt the secret version.
	KmsKeyIds []string

	// 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
	// contains filtered or unexported fields
}

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 StatusType 

type StatusType string
const (
	StatusTypeInSync     StatusType = "InSync"
	StatusTypeFailed     StatusType = "Failed"
	StatusTypeInProgress StatusType = "InProgress"
)

Enum values for StatusType

func (StatusType) Values 

func (StatusType) Values() []StatusType

Values returns all known values for StatusType. 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Displays errors that occurred during validation of the resource policy.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.