secretsmanager

package
v1.13.56 Latest Latest
Warning

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

 Go to latest Published: May 25, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package secretsmanager provides the client and types for making API requests to AWS Secrets Manager.

AWS Secrets Manager is a web service that enables 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 AWS Secrets Manager User Guide (http://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html).

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 directly, you can use one of the AWS 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 AWS Secrets Manager. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

We recommend that you use the AWS 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 (http://docs.aws.amazon.com/secretsmanager/latest/userguide/query-requests.html) in the AWS Secrets Manager User Guide.

Secrets Manager supports GET and POST requests for all actions. That is, the API 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 AWS Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com (mailto:awssecretsmanager-feedback@amazon.com), or post your feedback and questions in the AWS Secrets Manager Discussion Forum (http://forums.aws.amazon.com/forum.jspa?forumID=296). For more information about the AWS Discussion Forums, see Forums Help (http://forums.aws.amazon.com/help.jspa).

How examples are presented

The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Logging API Requests

AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail (http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail) in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html).

See https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17 for more information on this service.

See secretsmanager package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/

Using the Client

To contact AWS Secrets Manager with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Secrets Manager client SecretsManager for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/#New

Index

Examples

Constants

View Source 
const (

	// ErrCodeDecryptionFailure for service response error code
	// "DecryptionFailure".
	//
	// Secrets Manager can't decrypt the protected secret text using the provided
	// KMS key.
	ErrCodeDecryptionFailure = "DecryptionFailure"

	// ErrCodeEncryptionFailure for service response error code
	// "EncryptionFailure".
	//
	// 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).
	ErrCodeEncryptionFailure = "EncryptionFailure"

	// ErrCodeInternalServiceError for service response error code
	// "InternalServiceError".
	//
	// An error occurred on the server side.
	ErrCodeInternalServiceError = "InternalServiceError"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// You provided an invalid NextToken value.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// You provided an invalid value for a parameter.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// You provided a parameter value that is not valid for the current state of
	// the resource. For example, if you try to enable rotation on a secret, you
	// must already have a Lambda function ARN configured or included as a parameter
	// in this call.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request failed because it would exceed one of the Secrets Manager internal
	// limits.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMalformedPolicyDocumentException for service response error code
	// "MalformedPolicyDocumentException".
	//
	// The policy document that you provided isn't valid.
	ErrCodeMalformedPolicyDocumentException = "MalformedPolicyDocumentException"

	// ErrCodeResourceExistsException for service response error code
	// "ResourceExistsException".
	//
	// A resource with the ID you requested already exists.
	ErrCodeResourceExistsException = "ResourceExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// We can't find the resource that you asked for.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "secretsmanager" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName      // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelRotateSecretInput 

type CancelRotateSecretInput struct {

	// Specifies the secret for which you want to cancel a rotation request. You
	// can specify either the Amazon Resource Name (ARN) or the friendly name of
	// the secret.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelRotateSecretInput) GoString 

func (s CancelRotateSecretInput) GoString() string

GoString returns the string representation

func (*CancelRotateSecretInput) SetSecretId 

func (s *CancelRotateSecretInput) SetSecretId(v string) *CancelRotateSecretInput

SetSecretId sets the SecretId field's value.

func (CancelRotateSecretInput) String 

func (s CancelRotateSecretInput) String() string

String returns the string representation

func (*CancelRotateSecretInput) Validate 

func (s *CancelRotateSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelRotateSecretOutput 

type CancelRotateSecretOutput struct {

	// The ARN of the secret for which rotation was canceled.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret for which rotation was canceled.
	Name *string `min:"1" type:"string"`

	// The unique identifier of the version of the secret that was 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.
	VersionId *string `min:"32" type:"string"`
	// contains filtered or unexported fields
}

func (CancelRotateSecretOutput) GoString 

func (s CancelRotateSecretOutput) GoString() string

GoString returns the string representation

func (*CancelRotateSecretOutput) SetARN 

func (s *CancelRotateSecretOutput) SetARN(v string) *CancelRotateSecretOutput

SetARN sets the ARN field's value.

func (*CancelRotateSecretOutput) SetName 

func (s *CancelRotateSecretOutput) SetName(v string) *CancelRotateSecretOutput

SetName sets the Name field's value.

func (*CancelRotateSecretOutput) SetVersionId 

func (s *CancelRotateSecretOutput) SetVersionId(v string) *CancelRotateSecretOutput

SetVersionId sets the VersionId field's value.

func (CancelRotateSecretOutput) String 

func (s CancelRotateSecretOutput) String() string

String returns the string representation

type CreateSecretInput 

type CreateSecretInput struct {

	// (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 AWS CLI or one of the AWS SDK to call this operation, then
	// you can leave this parameter empty. The CLI or SDK generates a random UUID
	// for you and includes 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 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 a rotation. We recommend that you generate a UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier)
	// 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 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 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 SecretVersionId of the new version.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// (Optional) Specifies a user-provided description of the secret.
	Description *string `type:"string"`

	// (Optional) Specifies the ARN or alias of the AWS KMS customer master key
	// (CMK) to be used to encrypt the SecretString or SecretBinary values in the
	// versions stored in this secret.
	//
	// If you don't specify this value, then Secrets Manager defaults to using the
	// AWS account's default CMK (the one named aws/secretsmanager). If a 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's 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 is in a different account, then you must create a custom
	// CMK and specify the ARN in this field.
	KmsKeyId *string `type:"string"`

	// Specifies the friendly name of the new secret.
	//
	// The secret name must be ASCII letters, digits, or the following characters
	// : /_+=,.@-
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// (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 AWS CLI or one of the AWS SDKs.
	//
	// SecretBinary is automatically base64 encoded/decoded by the SDK.
	SecretBinary []byte `type:"blob"`

	// (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 information on how to format a
	// JSON parameter for the various command line tool environments, see Using
	// JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS CLI User Guide. For example:
	//
	// [{"username":"bob"},{"password":"abc123xyz456"}]
	//
	// 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.
	SecretString *string `type:"string"`

	// (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 (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS 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 it is
	//    reserved for AWS 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 your tagging schema will be used across multiple services and resources,
	//    remember that other services might have restrictions on allowed characters.
	//    Generally allowed characters are: letters, spaces, and numbers representable
	//    in UTF-8, plus the following special characters: + - = . _ : / @.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateSecretInput) GoString 

func (s CreateSecretInput) GoString() string

GoString returns the string representation

func (*CreateSecretInput) SetClientRequestToken 

func (s *CreateSecretInput) SetClientRequestToken(v string) *CreateSecretInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateSecretInput) SetDescription 

func (s *CreateSecretInput) SetDescription(v string) *CreateSecretInput

SetDescription sets the Description field's value.

func (*CreateSecretInput) SetKmsKeyId 

func (s *CreateSecretInput) SetKmsKeyId(v string) *CreateSecretInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateSecretInput) SetName 

func (s *CreateSecretInput) SetName(v string) *CreateSecretInput

SetName sets the Name field's value.

func (*CreateSecretInput) SetSecretBinary 

func (s *CreateSecretInput) SetSecretBinary(v []byte) *CreateSecretInput

SetSecretBinary sets the SecretBinary field's value.

func (*CreateSecretInput) SetSecretString 

func (s *CreateSecretInput) SetSecretString(v string) *CreateSecretInput

SetSecretString sets the SecretString field's value.

func (*CreateSecretInput) SetTags 

func (s *CreateSecretInput) SetTags(v []*Tag) *CreateSecretInput

SetTags sets the Tags field's value.

func (CreateSecretInput) String 

func (s CreateSecretInput) String() string

String returns the string representation

func (*CreateSecretInput) Validate 

func (s *CreateSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSecretOutput 

type CreateSecretOutput struct {

	// 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.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret that you just created.
	Name *string `min:"1" type:"string"`

	// The unique identifier that's associated with the version of the secret you
	// just created.
	VersionId *string `min:"32" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSecretOutput) GoString 

func (s CreateSecretOutput) GoString() string

GoString returns the string representation

func (*CreateSecretOutput) SetARN 

func (s *CreateSecretOutput) SetARN(v string) *CreateSecretOutput

SetARN sets the ARN field's value.

func (*CreateSecretOutput) SetName 

func (s *CreateSecretOutput) SetName(v string) *CreateSecretOutput

SetName sets the Name field's value.

func (*CreateSecretOutput) SetVersionId 

func (s *CreateSecretOutput) SetVersionId(v string) *CreateSecretOutput

SetVersionId sets the VersionId field's value.

func (CreateSecretOutput) String 

func (s CreateSecretOutput) String() string

String returns the string representation

type DeleteSecretInput 

type DeleteSecretInput struct {

	// (Optional) Specifies the number of days that Secrets Manager waits before
	// it can delete the secret.
	//
	// This value can range from 7 to 30 days. The default value is 30.
	RecoveryWindowInDays *int64 `type:"long"`

	// Specifies the secret that you want to delete. You can specify either the
	// Amazon Resource Name (ARN) or the friendly name of the secret.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSecretInput) GoString 

func (s DeleteSecretInput) GoString() string

GoString returns the string representation

func (*DeleteSecretInput) SetRecoveryWindowInDays 

func (s *DeleteSecretInput) SetRecoveryWindowInDays(v int64) *DeleteSecretInput

SetRecoveryWindowInDays sets the RecoveryWindowInDays field's value.

func (*DeleteSecretInput) SetSecretId 

func (s *DeleteSecretInput) SetSecretId(v string) *DeleteSecretInput

SetSecretId sets the SecretId field's value.

func (DeleteSecretInput) String 

func (s DeleteSecretInput) String() string

String returns the string representation

func (*DeleteSecretInput) Validate 

func (s *DeleteSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSecretOutput 

type DeleteSecretOutput struct {

	// The ARN of the secret that is now scheduled for deletion.
	ARN *string `min:"20" type:"string"`

	// 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.
	DeletionDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The friendly name of the secret that is now scheduled for deletion.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSecretOutput) GoString 

func (s DeleteSecretOutput) GoString() string

GoString returns the string representation

func (*DeleteSecretOutput) SetARN 

func (s *DeleteSecretOutput) SetARN(v string) *DeleteSecretOutput

SetARN sets the ARN field's value.

func (*DeleteSecretOutput) SetDeletionDate 

func (s *DeleteSecretOutput) SetDeletionDate(v time.Time) *DeleteSecretOutput

SetDeletionDate sets the DeletionDate field's value.

func (*DeleteSecretOutput) SetName 

func (s *DeleteSecretOutput) SetName(v string) *DeleteSecretOutput

SetName sets the Name field's value.

func (DeleteSecretOutput) String 

func (s DeleteSecretOutput) String() string

String returns the string representation

type DescribeSecretInput 

type DescribeSecretInput struct {

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSecretInput) GoString 

func (s DescribeSecretInput) GoString() string

GoString returns the string representation

func (*DescribeSecretInput) SetSecretId 

func (s *DescribeSecretInput) SetSecretId(v string) *DescribeSecretInput

SetSecretId sets the SecretId field's value.

func (DescribeSecretInput) String 

func (s DescribeSecretInput) String() string

String returns the string representation

func (*DescribeSecretInput) Validate 

func (s *DescribeSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSecretOutput 

type DescribeSecretOutput struct {

	// The ARN of the secret.
	ARN *string `min:"20" type:"string"`

	// 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.
	DeletedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The user-provided description of the secret.
	Description *string `type:"string"`

	// The ARN or alias of the AWS 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 KMS CMK (the one named awssecretsmanager)
	// for this account.
	KmsKeyId *string `type:"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 `type:"timestamp" timestampFormat:"unix"`

	// The last date and time that this secret was modified in any way.
	LastChangedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The last date and time that the Secrets Manager rotation process for this
	// secret was invoked.
	LastRotatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The user-provided friendly name of the secret.
	Name *string `min:"1" type:"string"`

	// 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.
	RotationEnabled *bool `type:"boolean"`

	// 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.
	RotationLambdaARN *string `type:"string"`

	// A structure that contains the rotation configuration for this secret.
	RotationRules *RotationRulesType `type:"structure"`

	// 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.
	Tags []*Tag `type:"list"`

	// A list of all of the currently assigned VersionStage staging labels and the
	// SecretVersionId 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.
	VersionIdsToStages map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

func (DescribeSecretOutput) GoString 

func (s DescribeSecretOutput) GoString() string

GoString returns the string representation

func (*DescribeSecretOutput) SetARN 

func (s *DescribeSecretOutput) SetARN(v string) *DescribeSecretOutput

SetARN sets the ARN field's value.

func (*DescribeSecretOutput) SetDeletedDate 

func (s *DescribeSecretOutput) SetDeletedDate(v time.Time) *DescribeSecretOutput

SetDeletedDate sets the DeletedDate field's value.

func (*DescribeSecretOutput) SetDescription 

func (s *DescribeSecretOutput) SetDescription(v string) *DescribeSecretOutput

SetDescription sets the Description field's value.

func (*DescribeSecretOutput) SetKmsKeyId 

func (s *DescribeSecretOutput) SetKmsKeyId(v string) *DescribeSecretOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*DescribeSecretOutput) SetLastAccessedDate 

func (s *DescribeSecretOutput) SetLastAccessedDate(v time.Time) *DescribeSecretOutput

SetLastAccessedDate sets the LastAccessedDate field's value.

func (*DescribeSecretOutput) SetLastChangedDate 

func (s *DescribeSecretOutput) SetLastChangedDate(v time.Time) *DescribeSecretOutput

SetLastChangedDate sets the LastChangedDate field's value.

func (*DescribeSecretOutput) SetLastRotatedDate 

func (s *DescribeSecretOutput) SetLastRotatedDate(v time.Time) *DescribeSecretOutput

SetLastRotatedDate sets the LastRotatedDate field's value.

func (*DescribeSecretOutput) SetName 

func (s *DescribeSecretOutput) SetName(v string) *DescribeSecretOutput

SetName sets the Name field's value.

func (*DescribeSecretOutput) SetRotationEnabled 

func (s *DescribeSecretOutput) SetRotationEnabled(v bool) *DescribeSecretOutput

SetRotationEnabled sets the RotationEnabled field's value.

func (*DescribeSecretOutput) SetRotationLambdaARN 

func (s *DescribeSecretOutput) SetRotationLambdaARN(v string) *DescribeSecretOutput

SetRotationLambdaARN sets the RotationLambdaARN field's value.

func (*DescribeSecretOutput) SetRotationRules 

func (s *DescribeSecretOutput) SetRotationRules(v *RotationRulesType) *DescribeSecretOutput

SetRotationRules sets the RotationRules field's value.

func (*DescribeSecretOutput) SetTags 

func (s *DescribeSecretOutput) SetTags(v []*Tag) *DescribeSecretOutput

SetTags sets the Tags field's value.

func (*DescribeSecretOutput) SetVersionIdsToStages 

func (s *DescribeSecretOutput) SetVersionIdsToStages(v map[string][]*string) *DescribeSecretOutput

SetVersionIdsToStages sets the VersionIdsToStages field's value.

func (DescribeSecretOutput) String 

func (s DescribeSecretOutput) String() string

String returns the string representation

type GetRandomPasswordInput 

type GetRandomPasswordInput struct {

	// 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.
	ExcludeCharacters *string `type:"string"`

	// 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.
	ExcludeLowercase *bool `type:"boolean"`

	// 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.
	ExcludeNumbers *bool `type:"boolean"`

	// 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.
	ExcludePunctuation *bool `type:"boolean"`

	// 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.
	ExcludeUppercase *bool `type:"boolean"`

	// 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.
	IncludeSpace *bool `type:"boolean"`

	// The desired length of the generated password. The default value if you do
	// not include this parameter is 32 characters.
	PasswordLength *int64 `min:"1" type:"long"`

	// 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.
	RequireEachIncludedType *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetRandomPasswordInput) GoString 

func (s GetRandomPasswordInput) GoString() string

GoString returns the string representation

func (*GetRandomPasswordInput) SetExcludeCharacters 

func (s *GetRandomPasswordInput) SetExcludeCharacters(v string) *GetRandomPasswordInput

SetExcludeCharacters sets the ExcludeCharacters field's value.

func (*GetRandomPasswordInput) SetExcludeLowercase 

func (s *GetRandomPasswordInput) SetExcludeLowercase(v bool) *GetRandomPasswordInput

SetExcludeLowercase sets the ExcludeLowercase field's value.

func (*GetRandomPasswordInput) SetExcludeNumbers 

func (s *GetRandomPasswordInput) SetExcludeNumbers(v bool) *GetRandomPasswordInput

SetExcludeNumbers sets the ExcludeNumbers field's value.

func (*GetRandomPasswordInput) SetExcludePunctuation 

func (s *GetRandomPasswordInput) SetExcludePunctuation(v bool) *GetRandomPasswordInput

SetExcludePunctuation sets the ExcludePunctuation field's value.

func (*GetRandomPasswordInput) SetExcludeUppercase 

func (s *GetRandomPasswordInput) SetExcludeUppercase(v bool) *GetRandomPasswordInput

SetExcludeUppercase sets the ExcludeUppercase field's value.

func (*GetRandomPasswordInput) SetIncludeSpace 

func (s *GetRandomPasswordInput) SetIncludeSpace(v bool) *GetRandomPasswordInput

SetIncludeSpace sets the IncludeSpace field's value.

func (*GetRandomPasswordInput) SetPasswordLength 

func (s *GetRandomPasswordInput) SetPasswordLength(v int64) *GetRandomPasswordInput

SetPasswordLength sets the PasswordLength field's value.

func (*GetRandomPasswordInput) SetRequireEachIncludedType 

func (s *GetRandomPasswordInput) SetRequireEachIncludedType(v bool) *GetRandomPasswordInput

SetRequireEachIncludedType sets the RequireEachIncludedType field's value.

func (GetRandomPasswordInput) String 

func (s GetRandomPasswordInput) String() string

String returns the string representation

func (*GetRandomPasswordInput) Validate 

func (s *GetRandomPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRandomPasswordOutput 

type GetRandomPasswordOutput struct {

	// A string with the generated password.
	RandomPassword *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetRandomPasswordOutput) GoString 

func (s GetRandomPasswordOutput) GoString() string

GoString returns the string representation

func (*GetRandomPasswordOutput) SetRandomPassword 

func (s *GetRandomPasswordOutput) SetRandomPassword(v string) *GetRandomPasswordOutput

SetRandomPassword sets the RandomPassword field's value.

func (GetRandomPasswordOutput) String 

func (s GetRandomPasswordOutput) String() string

String returns the string representation

type GetSecretValueInput 

type GetSecretValueInput struct {

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// Specifies the unique identifier of the version of the secret that you want
	// to retrieve. If you specify this parameter then don't specify VersionStage.
	// If you don't specify either a VersionStage or SecretVersionId then the default
	// is to perform the operation on the version with the VersionStage value of
	// AWSCURRENT.
	//
	// This value is typically a UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier)
	// value with 32 hexadecimal digits.
	VersionId *string `min:"32" type:"string"`

	// 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 use this parameter then don't specify SecretVersionId. If
	// you don't specify either a VersionStage or SecretVersionId, then the default
	// is to perform the operation on the version with the VersionStage value of
	// AWSCURRENT.
	VersionStage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetSecretValueInput) GoString 

func (s GetSecretValueInput) GoString() string

GoString returns the string representation

func (*GetSecretValueInput) SetSecretId 

func (s *GetSecretValueInput) SetSecretId(v string) *GetSecretValueInput

SetSecretId sets the SecretId field's value.

func (*GetSecretValueInput) SetVersionId 

func (s *GetSecretValueInput) SetVersionId(v string) *GetSecretValueInput

SetVersionId sets the VersionId field's value.

func (*GetSecretValueInput) SetVersionStage 

func (s *GetSecretValueInput) SetVersionStage(v string) *GetSecretValueInput

SetVersionStage sets the VersionStage field's value.

func (GetSecretValueInput) String 

func (s GetSecretValueInput) String() string

String returns the string representation

func (*GetSecretValueInput) Validate 

func (s *GetSecretValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSecretValueOutput 

type GetSecretValueOutput struct {

	// The ARN of the secret.
	ARN *string `min:"20" type:"string"`

	// The date and time that this version of the secret was created.
	CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The friendly name of the secret.
	Name *string `min:"1" type:"string"`

	// 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 (https://tools.ietf.org/html/rfc4648#section-4)
	// 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.
	//
	// SecretBinary is automatically base64 encoded/decoded by the SDK.
	SecretBinary []byte `type:"blob"`

	// 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.
	SecretString *string `type:"string"`

	// The unique identifier of this version of the secret.
	VersionId *string `min:"32" type:"string"`

	// A list of all of the staging labels currently attached to this version of
	// the secret.
	VersionStages []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetSecretValueOutput) GoString 

func (s GetSecretValueOutput) GoString() string

GoString returns the string representation

func (*GetSecretValueOutput) SetARN 

func (s *GetSecretValueOutput) SetARN(v string) *GetSecretValueOutput

SetARN sets the ARN field's value.

func (*GetSecretValueOutput) SetCreatedDate 

func (s *GetSecretValueOutput) SetCreatedDate(v time.Time) *GetSecretValueOutput

SetCreatedDate sets the CreatedDate field's value.

func (*GetSecretValueOutput) SetName 

func (s *GetSecretValueOutput) SetName(v string) *GetSecretValueOutput

SetName sets the Name field's value.

func (*GetSecretValueOutput) SetSecretBinary 

func (s *GetSecretValueOutput) SetSecretBinary(v []byte) *GetSecretValueOutput

SetSecretBinary sets the SecretBinary field's value.

func (*GetSecretValueOutput) SetSecretString 

func (s *GetSecretValueOutput) SetSecretString(v string) *GetSecretValueOutput

SetSecretString sets the SecretString field's value.

func (*GetSecretValueOutput) SetVersionId 

func (s *GetSecretValueOutput) SetVersionId(v string) *GetSecretValueOutput

SetVersionId sets the VersionId field's value.

func (*GetSecretValueOutput) SetVersionStages 

func (s *GetSecretValueOutput) SetVersionStages(v []*string) *GetSecretValueOutput

SetVersionStages sets the VersionStages field's value.

func (GetSecretValueOutput) String 

func (s GetSecretValueOutput) String() string

String returns the string representation

type ListSecretVersionIdsInput 

type ListSecretVersionIdsInput struct {

	// (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.
	IncludeDeprecated *bool `type:"boolean"`

	// (Optional) Limits the number of results that 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) Use this parameter in a request if you receive a NextToken response
	// in a previous request that indicates that there's more output available.
	// In a subsequent call, set it to the value of the previous call's NextToken
	// response to indicate where the output should continue from.
	NextToken *string `min:"1" type:"string"`

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListSecretVersionIdsInput) GoString 

func (s ListSecretVersionIdsInput) GoString() string

GoString returns the string representation

func (*ListSecretVersionIdsInput) SetIncludeDeprecated 

func (s *ListSecretVersionIdsInput) SetIncludeDeprecated(v bool) *ListSecretVersionIdsInput

SetIncludeDeprecated sets the IncludeDeprecated field's value.

func (*ListSecretVersionIdsInput) SetMaxResults 

func (s *ListSecretVersionIdsInput) SetMaxResults(v int64) *ListSecretVersionIdsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecretVersionIdsInput) SetNextToken 

func (s *ListSecretVersionIdsInput) SetNextToken(v string) *ListSecretVersionIdsInput

SetNextToken sets the NextToken field's value.

func (*ListSecretVersionIdsInput) SetSecretId 

func (s *ListSecretVersionIdsInput) SetSecretId(v string) *ListSecretVersionIdsInput

SetSecretId sets the SecretId field's value.

func (ListSecretVersionIdsInput) String 

func (s ListSecretVersionIdsInput) String() string

String returns the string representation

func (*ListSecretVersionIdsInput) Validate 

func (s *ListSecretVersionIdsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSecretVersionIdsOutput 

type ListSecretVersionIdsOutput struct {

	// 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.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret.
	Name *string `min:"1" type:"string"`

	// If present in the response, this value indicates that there's more output
	// available than what's 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).
	NextToken *string `min:"1" type:"string"`

	// The list of the currently available versions of the specified secret.
	Versions []*SecretVersionsListEntry `type:"list"`
	// contains filtered or unexported fields
}

func (ListSecretVersionIdsOutput) GoString 

func (s ListSecretVersionIdsOutput) GoString() string

GoString returns the string representation

func (*ListSecretVersionIdsOutput) SetARN 

func (s *ListSecretVersionIdsOutput) SetARN(v string) *ListSecretVersionIdsOutput

SetARN sets the ARN field's value.

func (*ListSecretVersionIdsOutput) SetName 

func (s *ListSecretVersionIdsOutput) SetName(v string) *ListSecretVersionIdsOutput

SetName sets the Name field's value.

func (*ListSecretVersionIdsOutput) SetNextToken 

func (s *ListSecretVersionIdsOutput) SetNextToken(v string) *ListSecretVersionIdsOutput

SetNextToken sets the NextToken field's value.

func (*ListSecretVersionIdsOutput) SetVersions 

func (s *ListSecretVersionIdsOutput) SetVersions(v []*SecretVersionsListEntry) *ListSecretVersionIdsOutput

SetVersions sets the Versions field's value.

func (ListSecretVersionIdsOutput) String 

func (s ListSecretVersionIdsOutput) String() string

String returns the string representation

type ListSecretsInput 

type ListSecretsInput struct {

	// (Optional) Limits the number of results that 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) Use this parameter in a request if you receive a NextToken response
	// in a previous request that indicates that there's more output available.
	// In a subsequent call, set it to the value of the previous call's NextToken
	// response to indicate where the output should continue from.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListSecretsInput) GoString 

func (s ListSecretsInput) GoString() string

GoString returns the string representation

func (*ListSecretsInput) SetMaxResults 

func (s *ListSecretsInput) SetMaxResults(v int64) *ListSecretsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecretsInput) SetNextToken 

func (s *ListSecretsInput) SetNextToken(v string) *ListSecretsInput

SetNextToken sets the NextToken field's value.

func (ListSecretsInput) String 

func (s ListSecretsInput) String() string

String returns the string representation

func (*ListSecretsInput) Validate 

func (s *ListSecretsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSecretsOutput 

type ListSecretsOutput struct {

	// If present in the response, this value indicates that there's more output
	// available than what's 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).
	NextToken *string `min:"1" type:"string"`

	// A list of the secrets in the account.
	SecretList []*SecretListEntry `type:"list"`
	// contains filtered or unexported fields
}

func (ListSecretsOutput) GoString 

func (s ListSecretsOutput) GoString() string

GoString returns the string representation

func (*ListSecretsOutput) SetNextToken 

func (s *ListSecretsOutput) SetNextToken(v string) *ListSecretsOutput

SetNextToken sets the NextToken field's value.

func (*ListSecretsOutput) SetSecretList 

func (s *ListSecretsOutput) SetSecretList(v []*SecretListEntry) *ListSecretsOutput

SetSecretList sets the SecretList field's value.

func (ListSecretsOutput) String 

func (s ListSecretsOutput) String() string

String returns the string representation

type PutSecretValueInput 

type PutSecretValueInput struct {

	// (Optional) Specifies a unique identifier for the new version of the secret.
	//
	// If you use the AWS CLI or one of the AWS 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 (https://wikipedia.org/wiki/Universally_unique_identifier) 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 that version's 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 SecretVersionId of the new version.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// (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.
	//
	// SecretBinary is automatically base64 encoded/decoded by the SDK.
	SecretBinary []byte `type:"blob"`

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// (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 information on how to format a
	// JSON parameter for the various command line tool environments, see Using
	// JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS CLI User Guide.
	//
	// For example:
	//
	// [{"username":"bob"},{"password":"abc123xyz456"}]
	//
	// 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.
	SecretString *string `type:"string"`

	// (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.
	VersionStages []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (PutSecretValueInput) GoString 

func (s PutSecretValueInput) GoString() string

GoString returns the string representation

func (*PutSecretValueInput) SetClientRequestToken 

func (s *PutSecretValueInput) SetClientRequestToken(v string) *PutSecretValueInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*PutSecretValueInput) SetSecretBinary 

func (s *PutSecretValueInput) SetSecretBinary(v []byte) *PutSecretValueInput

SetSecretBinary sets the SecretBinary field's value.

func (*PutSecretValueInput) SetSecretId 

func (s *PutSecretValueInput) SetSecretId(v string) *PutSecretValueInput

SetSecretId sets the SecretId field's value.

func (*PutSecretValueInput) SetSecretString 

func (s *PutSecretValueInput) SetSecretString(v string) *PutSecretValueInput

SetSecretString sets the SecretString field's value.

func (*PutSecretValueInput) SetVersionStages 

func (s *PutSecretValueInput) SetVersionStages(v []*string) *PutSecretValueInput

SetVersionStages sets the VersionStages field's value.

func (PutSecretValueInput) String 

func (s PutSecretValueInput) String() string

String returns the string representation

func (*PutSecretValueInput) Validate 

func (s *PutSecretValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutSecretValueOutput 

type PutSecretValueOutput struct {

	// The Amazon Resource Name (ARN) for the secret for which you just created
	// a version.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret for which you just created or updated a version.
	Name *string `min:"1" type:"string"`

	// The unique identifier of the version of the secret you just created or updated.
	VersionId *string `min:"32" type:"string"`

	// 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.
	VersionStages []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (PutSecretValueOutput) GoString 

func (s PutSecretValueOutput) GoString() string

GoString returns the string representation

func (*PutSecretValueOutput) SetARN 

func (s *PutSecretValueOutput) SetARN(v string) *PutSecretValueOutput

SetARN sets the ARN field's value.

func (*PutSecretValueOutput) SetName 

func (s *PutSecretValueOutput) SetName(v string) *PutSecretValueOutput

SetName sets the Name field's value.

func (*PutSecretValueOutput) SetVersionId 

func (s *PutSecretValueOutput) SetVersionId(v string) *PutSecretValueOutput

SetVersionId sets the VersionId field's value.

func (*PutSecretValueOutput) SetVersionStages 

func (s *PutSecretValueOutput) SetVersionStages(v []*string) *PutSecretValueOutput

SetVersionStages sets the VersionStages field's value.

func (PutSecretValueOutput) String 

func (s PutSecretValueOutput) String() string

String returns the string representation

type RestoreSecretInput 

type RestoreSecretInput struct {

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreSecretInput) GoString 

func (s RestoreSecretInput) GoString() string

GoString returns the string representation

func (*RestoreSecretInput) SetSecretId 

func (s *RestoreSecretInput) SetSecretId(v string) *RestoreSecretInput

SetSecretId sets the SecretId field's value.

func (RestoreSecretInput) String 

func (s RestoreSecretInput) String() string

String returns the string representation

func (*RestoreSecretInput) Validate 

func (s *RestoreSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreSecretOutput 

type RestoreSecretOutput struct {

	// The ARN of the secret that was restored.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret that was restored.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RestoreSecretOutput) GoString 

func (s RestoreSecretOutput) GoString() string

GoString returns the string representation

func (*RestoreSecretOutput) SetARN 

func (s *RestoreSecretOutput) SetARN(v string) *RestoreSecretOutput

SetARN sets the ARN field's value.

func (*RestoreSecretOutput) SetName 

func (s *RestoreSecretOutput) SetName(v string) *RestoreSecretOutput

SetName sets the Name field's value.

func (RestoreSecretOutput) String 

func (s RestoreSecretOutput) String() string

String returns the string representation

type RotateSecretInput 

type RotateSecretInput struct {

	// (Optional) Specifies a unique identifier for the new version of the secret
	// that helps ensure idempotency.
	//
	// If you use the AWS CLI or one of the AWS 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 are implementing your own
	// retry logic and want to ensure that a given secret is not created twice.
	// We recommend that you generate a UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier)
	// 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.
	//
	//    * 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 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 SecretVersionId of the new version.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
	RotationLambdaARN *string `type:"string"`

	// A structure that defines the rotation configuration for this secret.
	RotationRules *RotationRulesType `type:"structure"`

	// Specifies the secret that you want to rotate. You can specify either the
	// Amazon Resource Name (ARN) or the friendly name of the secret.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RotateSecretInput) GoString 

func (s RotateSecretInput) GoString() string

GoString returns the string representation

func (*RotateSecretInput) SetClientRequestToken 

func (s *RotateSecretInput) SetClientRequestToken(v string) *RotateSecretInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RotateSecretInput) SetRotationLambdaARN 

func (s *RotateSecretInput) SetRotationLambdaARN(v string) *RotateSecretInput

SetRotationLambdaARN sets the RotationLambdaARN field's value.

func (*RotateSecretInput) SetRotationRules 

func (s *RotateSecretInput) SetRotationRules(v *RotationRulesType) *RotateSecretInput

SetRotationRules sets the RotationRules field's value.

func (*RotateSecretInput) SetSecretId 

func (s *RotateSecretInput) SetSecretId(v string) *RotateSecretInput

SetSecretId sets the SecretId field's value.

func (RotateSecretInput) String 

func (s RotateSecretInput) String() string

String returns the string representation

func (*RotateSecretInput) Validate 

func (s *RotateSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RotateSecretOutput 

type RotateSecretOutput struct {

	// The ARN of the secret.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret.
	Name *string `min:"1" type:"string"`

	// The ID of the new version of the secret created by the rotation started by
	// this request.
	VersionId *string `min:"32" type:"string"`
	// contains filtered or unexported fields
}

func (RotateSecretOutput) GoString 

func (s RotateSecretOutput) GoString() string

GoString returns the string representation

func (*RotateSecretOutput) SetARN 

func (s *RotateSecretOutput) SetARN(v string) *RotateSecretOutput

SetARN sets the ARN field's value.

func (*RotateSecretOutput) SetName 

func (s *RotateSecretOutput) SetName(v string) *RotateSecretOutput

SetName sets the Name field's value.

func (*RotateSecretOutput) SetVersionId 

func (s *RotateSecretOutput) SetVersionId(v string) *RotateSecretOutput

SetVersionId sets the VersionId field's value.

func (RotateSecretOutput) String 

func (s RotateSecretOutput) String() string

String returns the string representation

type RotationRulesType 

type RotationRulesType struct {

	// Specifies the number of days between automatic scheduled rotations of the
	// secret.
	AutomaticallyAfterDays *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

A structure that defines the rotation configuration for the secret.

func (RotationRulesType) GoString 

func (s RotationRulesType) GoString() string

GoString returns the string representation

func (*RotationRulesType) SetAutomaticallyAfterDays 

func (s *RotationRulesType) SetAutomaticallyAfterDays(v int64) *RotationRulesType

SetAutomaticallyAfterDays sets the AutomaticallyAfterDays field's value.

func (RotationRulesType) String 

func (s RotationRulesType) String() string

String returns the string representation

func (*RotationRulesType) Validate 

func (s *RotationRulesType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SecretListEntry 

type SecretListEntry struct {

	// The Amazon Resource Name (ARN) of the secret.
	//
	// For more information about ARNs in Secrets Manager, see Policy Resources
	// (http://docs.aws.amazon.com/http:/docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources)
	// in the AWS Secrets Manager User Guide.
	ARN *string `min:"20" type:"string"`

	// The date and time on which this secret was deleted. 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 `type:"timestamp" timestampFormat:"unix"`

	// The user-provided description of the secret.
	Description *string `type:"string"`

	// The ARN or alias of the AWS KMS customer master key (CMK) that's 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 one named awssecretsmanager)
	// for this account.
	KmsKeyId *string `type:"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 `type:"timestamp" timestampFormat:"unix"`

	// The last date and time that this secret was modified in any way.
	LastChangedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The last date and time that the rotation process for this secret was invoked.
	LastRotatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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 `min:"1" type:"string"`

	// Indicated whether automatic, scheduled rotation is enabled for this secret.
	RotationEnabled *bool `type:"boolean"`

	// The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate
	// and expire the secret either automatically per the schedule or manually by
	// a call to RotateSecret.
	RotationLambdaARN *string `type:"string"`

	// A structure that defines the rotation configuration for the secret.
	RotationRules *RotationRulesType `type:"structure"`

	// A list of all of the currently assigned SecretVersionStage staging labels
	// and the SecretVersionId 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 SecretVersionStage is considered deprecated
	// and subject to deletion. Such versions are not included in this list.
	SecretVersionsToStages map[string][]*string `type:"map"`

	// 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.
	Tags []*Tag `type:"list"`
	// 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 the GetSecretValue operation.

func (SecretListEntry) GoString 

func (s SecretListEntry) GoString() string

GoString returns the string representation

func (*SecretListEntry) SetARN 

func (s *SecretListEntry) SetARN(v string) *SecretListEntry

SetARN sets the ARN field's value.

func (*SecretListEntry) SetDeletedDate 

func (s *SecretListEntry) SetDeletedDate(v time.Time) *SecretListEntry

SetDeletedDate sets the DeletedDate field's value.

func (*SecretListEntry) SetDescription 

func (s *SecretListEntry) SetDescription(v string) *SecretListEntry

SetDescription sets the Description field's value.

func (*SecretListEntry) SetKmsKeyId 

func (s *SecretListEntry) SetKmsKeyId(v string) *SecretListEntry

SetKmsKeyId sets the KmsKeyId field's value.

func (*SecretListEntry) SetLastAccessedDate 

func (s *SecretListEntry) SetLastAccessedDate(v time.Time) *SecretListEntry

SetLastAccessedDate sets the LastAccessedDate field's value.

func (*SecretListEntry) SetLastChangedDate 

func (s *SecretListEntry) SetLastChangedDate(v time.Time) *SecretListEntry

SetLastChangedDate sets the LastChangedDate field's value.

func (*SecretListEntry) SetLastRotatedDate 

func (s *SecretListEntry) SetLastRotatedDate(v time.Time) *SecretListEntry

SetLastRotatedDate sets the LastRotatedDate field's value.

func (*SecretListEntry) SetName 

func (s *SecretListEntry) SetName(v string) *SecretListEntry

SetName sets the Name field's value.

func (*SecretListEntry) SetRotationEnabled 

func (s *SecretListEntry) SetRotationEnabled(v bool) *SecretListEntry

SetRotationEnabled sets the RotationEnabled field's value.

func (*SecretListEntry) SetRotationLambdaARN 

func (s *SecretListEntry) SetRotationLambdaARN(v string) *SecretListEntry

SetRotationLambdaARN sets the RotationLambdaARN field's value.

func (*SecretListEntry) SetRotationRules 

func (s *SecretListEntry) SetRotationRules(v *RotationRulesType) *SecretListEntry

SetRotationRules sets the RotationRules field's value.

func (*SecretListEntry) SetSecretVersionsToStages 

func (s *SecretListEntry) SetSecretVersionsToStages(v map[string][]*string) *SecretListEntry

SetSecretVersionsToStages sets the SecretVersionsToStages field's value.

func (*SecretListEntry) SetTags 

func (s *SecretListEntry) SetTags(v []*Tag) *SecretListEntry

SetTags sets the Tags field's value.

func (SecretListEntry) String 

func (s SecretListEntry) String() string

String returns the string representation

type SecretVersionsListEntry 

type SecretVersionsListEntry struct {

	// The date and time this version of the secret was created.
	CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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 `type:"timestamp" timestampFormat:"unix"`

	// The unique version identifier of this version of the secret.
	VersionId *string `min:"32" type:"string"`

	// An array of staging labels that are currently associated with this version
	// of the secret.
	VersionStages []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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

func (SecretVersionsListEntry) GoString 

func (s SecretVersionsListEntry) GoString() string

GoString returns the string representation

func (*SecretVersionsListEntry) SetCreatedDate 

func (s *SecretVersionsListEntry) SetCreatedDate(v time.Time) *SecretVersionsListEntry

SetCreatedDate sets the CreatedDate field's value.

func (*SecretVersionsListEntry) SetLastAccessedDate 

func (s *SecretVersionsListEntry) SetLastAccessedDate(v time.Time) *SecretVersionsListEntry

SetLastAccessedDate sets the LastAccessedDate field's value.

func (*SecretVersionsListEntry) SetVersionId 

func (s *SecretVersionsListEntry) SetVersionId(v string) *SecretVersionsListEntry

SetVersionId sets the VersionId field's value.

func (*SecretVersionsListEntry) SetVersionStages 

func (s *SecretVersionsListEntry) SetVersionStages(v []*string) *SecretVersionsListEntry

SetVersionStages sets the VersionStages field's value.

func (SecretVersionsListEntry) String 

func (s SecretVersionsListEntry) String() string

String returns the string representation

type SecretsManager 

type SecretsManager struct {
	*client.Client
}

SecretsManager provides the API operation methods for making requests to AWS Secrets Manager. See this package's package overview docs for details on the service.

SecretsManager methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SecretsManager

New creates a new instance of the SecretsManager client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a SecretsManager client from just a session.
svc := secretsmanager.New(mySession)

// Create a SecretsManager client with additional configuration
svc := secretsmanager.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SecretsManager) CancelRotateSecret 

func (c *SecretsManager) CancelRotateSecret(input *CancelRotateSecretInput) (*CancelRotateSecretOutput, error)

CancelRotateSecret API operation for AWS Secrets Manager.

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the SecretVersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

  • Not be attached to any version at all

  • Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CancelRotateSecret

Related operations

  • To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

  • To get the rotation configuration details for a secret, use DescribeSecret.

  • To list all of the currently available secrets, use ListSecrets.

  • To list all of the versions currently associated with a secret, use ListSecretVersionIds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation CancelRotateSecret for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecret

Example (Shared00)

To cancel scheduled rotation for a secret

The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.CancelRotateSecretInput{
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.CancelRotateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) CancelRotateSecretRequest 

func (c *SecretsManager) CancelRotateSecretRequest(input *CancelRotateSecretInput) (req *request.Request, output *CancelRotateSecretOutput)

CancelRotateSecretRequest generates a "aws/request.Request" representing the client's request for the CancelRotateSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelRotateSecret for more information on using the CancelRotateSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelRotateSecretRequest method.
req, resp := client.CancelRotateSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecret

func (*SecretsManager) CancelRotateSecretWithContext 

func (c *SecretsManager) CancelRotateSecretWithContext(ctx aws.Context, input *CancelRotateSecretInput, opts ...request.Option) (*CancelRotateSecretOutput, error)

CancelRotateSecretWithContext is the same as CancelRotateSecret with the addition of the ability to pass a context and additional request options.

See CancelRotateSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) CreateSecret 

func (c *SecretsManager) CreateSecret(input *CreateSecretInput) (*CreateSecretOutput, error)

CreateSecret API operation for AWS Secrets Manager.

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CreateSecret

  • kms:GenerateDataKey - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

  • To delete a secret, use DeleteSecret.

  • To modify an existing secret, use UpdateSecret.

  • To create a new version of a secret, use PutSecretValue.

  • To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

  • To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.

  • To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation CreateSecret for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeLimitExceededException "LimitExceededException" The request failed because it would exceed one of the Secrets Manager internal limits.

  • ErrCodeEncryptionFailure "EncryptionFailure" 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).

  • ErrCodeResourceExistsException "ResourceExistsException" A resource with the ID you requested already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeMalformedPolicyDocumentException "MalformedPolicyDocumentException" The policy document that you provided isn't valid.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecret

Example (Shared00)

To create a basic secret

The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.CreateSecretInput{
		ClientRequestToken: aws.String("EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"),
		Description:        aws.String("My test database secret created with the CLI"),
		Name:               aws.String("MyTestDatabaseSecret"),
		SecretString:       aws.String("{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}"),
	}

	result, err := svc.CreateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeEncryptionFailure:
				fmt.Println(secretsmanager.ErrCodeEncryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeResourceExistsException:
				fmt.Println(secretsmanager.ErrCodeResourceExistsException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeMalformedPolicyDocumentException:
				fmt.Println(secretsmanager.ErrCodeMalformedPolicyDocumentException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) CreateSecretRequest 

func (c *SecretsManager) CreateSecretRequest(input *CreateSecretInput) (req *request.Request, output *CreateSecretOutput)

CreateSecretRequest generates a "aws/request.Request" representing the client's request for the CreateSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSecret for more information on using the CreateSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSecretRequest method.
req, resp := client.CreateSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecret

func (*SecretsManager) CreateSecretWithContext 

func (c *SecretsManager) CreateSecretWithContext(ctx aws.Context, input *CreateSecretInput, opts ...request.Option) (*CreateSecretOutput, error)

CreateSecretWithContext is the same as CreateSecret with the addition of the ability to pass a context and additional request options.

See CreateSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) DeleteSecret 

func (c *SecretsManager) DeleteSecret(input *DeleteSecretInput) (*DeleteSecretOutput, error)

DeleteSecret API operation for AWS Secrets Manager.

Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated.

The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DeleteSecret

Related operations

  • To create a secret, use CreateSecret.

  • To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation DeleteSecret for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteSecret

Example (Shared00)

To delete a secret

The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.DeleteSecretInput{
		RecoveryWindowInDays: aws.Int64(7),
		SecretId:             aws.String("MyTestDatabaseSecret1"),
	}

	result, err := svc.DeleteSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) DeleteSecretRequest 

func (c *SecretsManager) DeleteSecretRequest(input *DeleteSecretInput) (req *request.Request, output *DeleteSecretOutput)

DeleteSecretRequest generates a "aws/request.Request" representing the client's request for the DeleteSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSecret for more information on using the DeleteSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSecretRequest method.
req, resp := client.DeleteSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteSecret

func (*SecretsManager) DeleteSecretWithContext 

func (c *SecretsManager) DeleteSecretWithContext(ctx aws.Context, input *DeleteSecretInput, opts ...request.Option) (*DeleteSecretOutput, error)

DeleteSecretWithContext is the same as DeleteSecret with the addition of the ability to pass a context and additional request options.

See DeleteSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) DescribeSecret 

func (c *SecretsManager) DescribeSecret(input *DescribeSecretInput) (*DescribeSecretOutput, error)

DescribeSecret API operation for AWS Secrets Manager.

Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DescribeSecret

Related operations

  • To create a secret, use CreateSecret.

  • To modify a secret, use UpdateSecret.

  • To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.

  • To list all of the secrets in the AWS account, use ListSecrets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation DescribeSecret for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecret

Example (Shared00)

To retrieve the details of a secret

The following example shows how to get the details about a secret. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.DescribeSecretInput{
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.DescribeSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) DescribeSecretRequest 

func (c *SecretsManager) DescribeSecretRequest(input *DescribeSecretInput) (req *request.Request, output *DescribeSecretOutput)

DescribeSecretRequest generates a "aws/request.Request" representing the client's request for the DescribeSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSecret for more information on using the DescribeSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSecretRequest method.
req, resp := client.DescribeSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecret

func (*SecretsManager) DescribeSecretWithContext 

func (c *SecretsManager) DescribeSecretWithContext(ctx aws.Context, input *DescribeSecretInput, opts ...request.Option) (*DescribeSecretOutput, error)

DescribeSecretWithContext is the same as DescribeSecret with the addition of the ability to pass a context and additional request options.

See DescribeSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) GetRandomPassword 

func (c *SecretsManager) GetRandomPassword(input *GetRandomPasswordInput) (*GetRandomPasswordOutput, error)

GetRandomPassword API operation for AWS Secrets Manager.

Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetRandomPassword

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation GetRandomPassword for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetRandomPassword

Example (Shared00)

To generate a random password

The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.GetRandomPasswordInput{
		IncludeSpace:            aws.Bool(true),
		PasswordLength:          aws.Int64(20),
		RequireEachIncludedType: aws.Bool(true),
	}

	result, err := svc.GetRandomPassword(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) GetRandomPasswordRequest 

func (c *SecretsManager) GetRandomPasswordRequest(input *GetRandomPasswordInput) (req *request.Request, output *GetRandomPasswordOutput)

GetRandomPasswordRequest generates a "aws/request.Request" representing the client's request for the GetRandomPassword operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRandomPassword for more information on using the GetRandomPassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetRandomPasswordRequest method.
req, resp := client.GetRandomPasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetRandomPassword

func (*SecretsManager) GetRandomPasswordWithContext 

func (c *SecretsManager) GetRandomPasswordWithContext(ctx aws.Context, input *GetRandomPasswordInput, opts ...request.Option) (*GetRandomPasswordOutput, error)

GetRandomPasswordWithContext is the same as GetRandomPassword with the addition of the ability to pass a context and additional request options.

See GetRandomPassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) GetSecretValue 

func (c *SecretsManager) GetSecretValue(input *GetSecretValueInput) (*GetSecretValueOutput, error)

GetSecretValue API operation for AWS Secrets Manager.

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetSecretValue

  • kms:Decrypt - required only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

  • To create a new version of the secret with different encrypted information, use PutSecretValue.

  • To retrieve the non-encrypted details for the secret, use DescribeSecret.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation GetSecretValue for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeDecryptionFailure "DecryptionFailure" Secrets Manager can't decrypt the protected secret text using the provided KMS key.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetSecretValue

Example (Shared00)

To retrieve the encrypted secret value of a secret

The following example shows how to retrieve the secret string value from the version of the secret that has the AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the VersionStage parameter because it defaults to AWSCURRENT. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.GetSecretValueInput{
		SecretId:     aws.String("MyTestDatabaseSecret"),
		VersionStage: aws.String("AWSPREVIOUS"),
	}

	result, err := svc.GetSecretValue(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeDecryptionFailure:
				fmt.Println(secretsmanager.ErrCodeDecryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) GetSecretValueRequest 

func (c *SecretsManager) GetSecretValueRequest(input *GetSecretValueInput) (req *request.Request, output *GetSecretValueOutput)

GetSecretValueRequest generates a "aws/request.Request" representing the client's request for the GetSecretValue operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSecretValue for more information on using the GetSecretValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSecretValueRequest method.
req, resp := client.GetSecretValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetSecretValue

func (*SecretsManager) GetSecretValueWithContext 

func (c *SecretsManager) GetSecretValueWithContext(ctx aws.Context, input *GetSecretValueInput, opts ...request.Option) (*GetSecretValueOutput, error)

GetSecretValueWithContext is the same as GetSecretValue with the addition of the ability to pass a context and additional request options.

See GetSecretValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) ListSecretVersionIds 

func (c *SecretsManager) ListSecretVersionIds(input *ListSecretVersionIdsInput) (*ListSecretVersionIdsOutput, error)

ListSecretVersionIds API operation for AWS Secrets Manager.

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecretVersionIds

Related operations

  • To list the secrets in an account, use ListSecrets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation ListSecretVersionIds for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" You provided an invalid NextToken value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecretVersionIds

Example (Shared00)

To list all of the secret versions associated with a secret

The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.ListSecretVersionIdsInput{
		IncludeDeprecated: aws.Bool(true),
		SecretId:          aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.ListSecretVersionIds(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidNextTokenException:
				fmt.Println(secretsmanager.ErrCodeInvalidNextTokenException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) ListSecretVersionIdsPages 

func (c *SecretsManager) ListSecretVersionIdsPages(input *ListSecretVersionIdsInput, fn func(*ListSecretVersionIdsOutput, bool) bool) error

ListSecretVersionIdsPages iterates over the pages of a ListSecretVersionIds operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSecretVersionIds method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSecretVersionIds operation.
pageNum := 0
err := client.ListSecretVersionIdsPages(params,
    func(page *ListSecretVersionIdsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecretsManager) ListSecretVersionIdsPagesWithContext 

func (c *SecretsManager) ListSecretVersionIdsPagesWithContext(ctx aws.Context, input *ListSecretVersionIdsInput, fn func(*ListSecretVersionIdsOutput, bool) bool, opts ...request.Option) error

ListSecretVersionIdsPagesWithContext same as ListSecretVersionIdsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) ListSecretVersionIdsRequest 

func (c *SecretsManager) ListSecretVersionIdsRequest(input *ListSecretVersionIdsInput) (req *request.Request, output *ListSecretVersionIdsOutput)

ListSecretVersionIdsRequest generates a "aws/request.Request" representing the client's request for the ListSecretVersionIds operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSecretVersionIds for more information on using the ListSecretVersionIds API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSecretVersionIdsRequest method.
req, resp := client.ListSecretVersionIdsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecretVersionIds

func (*SecretsManager) ListSecretVersionIdsWithContext 

func (c *SecretsManager) ListSecretVersionIdsWithContext(ctx aws.Context, input *ListSecretVersionIdsInput, opts ...request.Option) (*ListSecretVersionIdsOutput, error)

ListSecretVersionIdsWithContext is the same as ListSecretVersionIds with the addition of the ability to pass a context and additional request options.

See ListSecretVersionIds for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) ListSecrets 

func (c *SecretsManager) ListSecrets(input *ListSecretsInput) (*ListSecretsOutput, error)

ListSecrets API operation for AWS Secrets Manager.

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecrets

Related operations

  • To list the versions attached to a secret, use ListSecretVersionIds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation ListSecrets for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" You provided an invalid NextToken value.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecrets

Example (Shared00)

To list the secrets in your account

The following example shows how to list all of the secrets in your account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.ListSecretsInput{}

	result, err := svc.ListSecrets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidNextTokenException:
				fmt.Println(secretsmanager.ErrCodeInvalidNextTokenException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) ListSecretsPages 

func (c *SecretsManager) ListSecretsPages(input *ListSecretsInput, fn func(*ListSecretsOutput, bool) bool) error

ListSecretsPages iterates over the pages of a ListSecrets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSecrets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSecrets operation.
pageNum := 0
err := client.ListSecretsPages(params,
    func(page *ListSecretsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecretsManager) ListSecretsPagesWithContext 

func (c *SecretsManager) ListSecretsPagesWithContext(ctx aws.Context, input *ListSecretsInput, fn func(*ListSecretsOutput, bool) bool, opts ...request.Option) error

ListSecretsPagesWithContext same as ListSecretsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) ListSecretsRequest 

func (c *SecretsManager) ListSecretsRequest(input *ListSecretsInput) (req *request.Request, output *ListSecretsOutput)

ListSecretsRequest generates a "aws/request.Request" representing the client's request for the ListSecrets operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSecrets for more information on using the ListSecrets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSecretsRequest method.
req, resp := client.ListSecretsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecrets

func (*SecretsManager) ListSecretsWithContext 

func (c *SecretsManager) ListSecretsWithContext(ctx aws.Context, input *ListSecretsInput, opts ...request.Option) (*ListSecretsOutput, error)

ListSecretsWithContext is the same as ListSecrets with the addition of the ability to pass a context and additional request options.

See ListSecrets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) PutSecretValue 

func (c *SecretsManager) PutSecretValue(input *PutSecretValueInput) (*PutSecretValueOutput, error)

PutSecretValue API operation for AWS Secrets Manager.

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

  • If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.

  • If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

  • This operation is idempotent. If a version with a SecretVersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutSecretValue

  • kms:GenerateDataKey - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

  • kms:Encrypt - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

  • To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.

  • To create a secret, use CreateSecret.

  • To get the details for a secret, use DescribeSecret.

  • To list the versions attached to a secret, use ListSecretVersionIds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation PutSecretValue for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeLimitExceededException "LimitExceededException" The request failed because it would exceed one of the Secrets Manager internal limits.

  • ErrCodeEncryptionFailure "EncryptionFailure" 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).

  • ErrCodeResourceExistsException "ResourceExistsException" A resource with the ID you requested already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutSecretValue

Example (Shared00)

To store a secret value in a new version of a secret

The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.PutSecretValueInput{
		ClientRequestToken: aws.String("EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE"),
		SecretId:           aws.String("MyTestDatabaseSecret"),
		SecretString:       aws.String("{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}"),
	}

	result, err := svc.PutSecretValue(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeEncryptionFailure:
				fmt.Println(secretsmanager.ErrCodeEncryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeResourceExistsException:
				fmt.Println(secretsmanager.ErrCodeResourceExistsException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) PutSecretValueRequest 

func (c *SecretsManager) PutSecretValueRequest(input *PutSecretValueInput) (req *request.Request, output *PutSecretValueOutput)

PutSecretValueRequest generates a "aws/request.Request" representing the client's request for the PutSecretValue operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutSecretValue for more information on using the PutSecretValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutSecretValueRequest method.
req, resp := client.PutSecretValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutSecretValue

func (*SecretsManager) PutSecretValueWithContext 

func (c *SecretsManager) PutSecretValueWithContext(ctx aws.Context, input *PutSecretValueInput, opts ...request.Option) (*PutSecretValueOutput, error)

PutSecretValueWithContext is the same as PutSecretValue with the addition of the ability to pass a context and additional request options.

See PutSecretValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) RestoreSecret 

func (c *SecretsManager) RestoreSecret(input *RestoreSecretInput) (*RestoreSecretOutput, error)

RestoreSecret API operation for AWS Secrets Manager.

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RestoreSecret

Related operations

  • To delete a secret, use DeleteSecret.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation RestoreSecret for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecret

Example (Shared00)

To restore a previously deleted secret

The following example shows how to restore a secret that you previously scheduled for deletion. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.RestoreSecretInput{
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.RestoreSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) RestoreSecretRequest 

func (c *SecretsManager) RestoreSecretRequest(input *RestoreSecretInput) (req *request.Request, output *RestoreSecretOutput)

RestoreSecretRequest generates a "aws/request.Request" representing the client's request for the RestoreSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreSecret for more information on using the RestoreSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreSecretRequest method.
req, resp := client.RestoreSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecret

func (*SecretsManager) RestoreSecretWithContext 

func (c *SecretsManager) RestoreSecretWithContext(ctx aws.Context, input *RestoreSecretInput, opts ...request.Option) (*RestoreSecretOutput, error)

RestoreSecretWithContext is the same as RestoreSecret with the addition of the ability to pass a context and additional request options.

See RestoreSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) RotateSecret 

func (c *SecretsManager) RotateSecret(input *RotateSecretInput) (*RotateSecretOutput, error)

RotateSecret API operation for AWS Secrets Manager.

Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager (http://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) in the AWS Secrets Manager User Guide.

The rotation function must end with the versions of the secret in one of two states:

  • The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or

  • The AWSPENDING staging label is not attached to any version of the secret.

If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RotateSecret

  • lambda:InvokeFunction (on the function specified in the secret's metadata)

Related operations

  • To list the secrets in your account, use ListSecrets.

  • To get the details for a version of a secret, use DescribeSecret.

  • To create a new version of a secret, use CreateSecret.

  • To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation RotateSecret for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RotateSecret

Example (Shared00)

To configure rotation for a secret

The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.RotateSecretInput{
		RotationLambdaARN: aws.String("arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda"),
		RotationRules: &secretsmanager.RotationRulesType{
			AutomaticallyAfterDays: aws.Int64(30),
		},
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.RotateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To request an immediate rotation for a secret

The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.RotateSecretInput{
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.RotateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) RotateSecretRequest 

func (c *SecretsManager) RotateSecretRequest(input *RotateSecretInput) (req *request.Request, output *RotateSecretOutput)

RotateSecretRequest generates a "aws/request.Request" representing the client's request for the RotateSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RotateSecret for more information on using the RotateSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RotateSecretRequest method.
req, resp := client.RotateSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RotateSecret

func (*SecretsManager) RotateSecretWithContext 

func (c *SecretsManager) RotateSecretWithContext(ctx aws.Context, input *RotateSecretInput, opts ...request.Option) (*RotateSecretOutput, error)

RotateSecretWithContext is the same as RotateSecret with the addition of the ability to pass a context and additional request options.

See RotateSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) TagResource 

func (c *SecretsManager) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Secrets Manager.

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:TagResource

Related operations

  • To remove one or more tags from the collection attached to a secret, use UntagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/TagResource

Example (Shared00)

To add tags to a secret

The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.TagResourceInput{
		SecretId: aws.String("MyExampleSecret"),
		Tags: []*secretsmanager.Tag{
			{
				Key:   aws.String("FirstTag"),
				Value: aws.String("SomeValue"),
			},
			{
				Key:   aws.String("SecondTag"),
				Value: aws.String("AnotherValue"),
			},
		},
	}

	result, err := svc.TagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) TagResourceRequest 

func (c *SecretsManager) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/TagResource

func (*SecretsManager) TagResourceWithContext 

func (c *SecretsManager) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) UntagResource 

func (c *SecretsManager) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Secrets Manager.

Removes one or more tags from the specified secret.

This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.

If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UntagResource

Related operations

  • To add one or more tags to the collection attached to a secret, use TagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UntagResource

Example (Shared00)

To remove tags from a secret

The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UntagResourceInput{
		SecretId: aws.String("MyTestDatabaseSecret"),
		TagKeys: []*string{
			aws.String("FirstTag"),
			aws.String("SecondTag"),
		},
	}

	result, err := svc.UntagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) UntagResourceRequest 

func (c *SecretsManager) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UntagResource

func (*SecretsManager) UntagResourceWithContext 

func (c *SecretsManager) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) UpdateSecret 

func (c *SecretsManager) UpdateSecret(input *UpdateSecretInput) (*UpdateSecretOutput, error)

UpdateSecret API operation for AWS Secrets Manager.

Modifies many of the details of a secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

To modify the rotation configuration of a secret, use RotateSecret instead.

The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

  • If a version with a SecretVersionId with the same value as the ClientRequestToken parameter already exists, the operation generates an error. You cannot modify an existing version, you can only create new ones.

  • If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecret

  • kms:GenerateDataKey - needed only if you use a custom KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a custom KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

  • To create a new secret, use CreateSecret.

  • To add only a new version to an existing secret, use PutSecretValue.

  • To get the details for a secret, use DescribeSecret.

  • To list the versions contained in a secret, use ListSecretVersionIds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation UpdateSecret for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeLimitExceededException "LimitExceededException" The request failed because it would exceed one of the Secrets Manager internal limits.

  • ErrCodeEncryptionFailure "EncryptionFailure" 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).

  • ErrCodeResourceExistsException "ResourceExistsException" A resource with the ID you requested already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeMalformedPolicyDocumentException "MalformedPolicyDocumentException" The policy document that you provided isn't valid.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UpdateSecret

Example (Shared00)

To update the description of a secret

The following example shows how to modify the description of a secret. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretInput{
		ClientRequestToken: aws.String("EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE"),
		Description:        aws.String("This is a new description for the secret."),
		SecretId:           aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.UpdateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeEncryptionFailure:
				fmt.Println(secretsmanager.ErrCodeEncryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeResourceExistsException:
				fmt.Println(secretsmanager.ErrCodeResourceExistsException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeMalformedPolicyDocumentException:
				fmt.Println(secretsmanager.ErrCodeMalformedPolicyDocumentException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To update the KMS key associated with a secret

This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretInput{
		KmsKeyId: aws.String("arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE"),
		SecretId: aws.String("MyTestDatabaseSecret"),
	}

	result, err := svc.UpdateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeEncryptionFailure:
				fmt.Println(secretsmanager.ErrCodeEncryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeResourceExistsException:
				fmt.Println(secretsmanager.ErrCodeResourceExistsException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeMalformedPolicyDocumentException:
				fmt.Println(secretsmanager.ErrCodeMalformedPolicyDocumentException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared02)

To create a new version of the encrypted secret value

The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretInput{
		SecretId:     aws.String("MyTestDatabaseSecret"),
		SecretString: aws.String("{JSON STRING WITH CREDENTIALS}"),
	}

	result, err := svc.UpdateSecret(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeEncryptionFailure:
				fmt.Println(secretsmanager.ErrCodeEncryptionFailure, aerr.Error())
			case secretsmanager.ErrCodeResourceExistsException:
				fmt.Println(secretsmanager.ErrCodeResourceExistsException, aerr.Error())
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeMalformedPolicyDocumentException:
				fmt.Println(secretsmanager.ErrCodeMalformedPolicyDocumentException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) UpdateSecretRequest 

func (c *SecretsManager) UpdateSecretRequest(input *UpdateSecretInput) (req *request.Request, output *UpdateSecretOutput)

UpdateSecretRequest generates a "aws/request.Request" representing the client's request for the UpdateSecret operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSecret for more information on using the UpdateSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSecretRequest method.
req, resp := client.UpdateSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UpdateSecret

func (*SecretsManager) UpdateSecretVersionStage 

func (c *SecretsManager) UpdateSecretVersionStage(input *UpdateSecretVersionStageInput) (*UpdateSecretVersionStageOutput, error)

UpdateSecretVersionStage API operation for AWS Secrets Manager.

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels (http://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label) in the AWS Secrets Manager User Guide.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecretVersionStage

Related operations

  • To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Secrets Manager's API operation UpdateSecretVersionStage for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find the resource that you asked for.

  • ErrCodeInvalidParameterException "InvalidParameterException" You provided an invalid value for a parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

  • ErrCodeLimitExceededException "LimitExceededException" The request failed because it would exceed one of the Secrets Manager internal limits.

  • ErrCodeInternalServiceError "InternalServiceError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UpdateSecretVersionStage

Example (Shared00)

To add a staging label attached to a version of a secret

The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretVersionStageInput{
		MoveToVersionId: aws.String("EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"),
		SecretId:        aws.String("MyTestDatabaseSecret"),
		VersionStage:    aws.String("STAGINGLABEL1"),
	}

	result, err := svc.UpdateSecretVersionStage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To delete a staging label attached to a version of a secret

The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretVersionStageInput{
		RemoveFromVersionId: aws.String("EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"),
		SecretId:            aws.String("MyTestDatabaseSecret"),
		VersionStage:        aws.String("STAGINGLABEL1"),
	}

	result, err := svc.UpdateSecretVersionStage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared02)

To move a staging label from one version of a secret to another

The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/secretsmanager"
)

func main() {
	svc := secretsmanager.New(session.New())
	input := &secretsmanager.UpdateSecretVersionStageInput{
		MoveToVersionId:     aws.String("EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"),
		RemoveFromVersionId: aws.String("EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"),
		SecretId:            aws.String("MyTestDatabaseSecret"),
		VersionStage:        aws.String("AWSCURRENT"),
	}

	result, err := svc.UpdateSecretVersionStage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case secretsmanager.ErrCodeResourceNotFoundException:
				fmt.Println(secretsmanager.ErrCodeResourceNotFoundException, aerr.Error())
			case secretsmanager.ErrCodeInvalidParameterException:
				fmt.Println(secretsmanager.ErrCodeInvalidParameterException, aerr.Error())
			case secretsmanager.ErrCodeInvalidRequestException:
				fmt.Println(secretsmanager.ErrCodeInvalidRequestException, aerr.Error())
			case secretsmanager.ErrCodeLimitExceededException:
				fmt.Println(secretsmanager.ErrCodeLimitExceededException, aerr.Error())
			case secretsmanager.ErrCodeInternalServiceError:
				fmt.Println(secretsmanager.ErrCodeInternalServiceError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*SecretsManager) UpdateSecretVersionStageRequest 

func (c *SecretsManager) UpdateSecretVersionStageRequest(input *UpdateSecretVersionStageInput) (req *request.Request, output *UpdateSecretVersionStageOutput)

UpdateSecretVersionStageRequest generates a "aws/request.Request" representing the client's request for the UpdateSecretVersionStage operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSecretVersionStage for more information on using the UpdateSecretVersionStage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSecretVersionStageRequest method.
req, resp := client.UpdateSecretVersionStageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UpdateSecretVersionStage

func (*SecretsManager) UpdateSecretVersionStageWithContext 

func (c *SecretsManager) UpdateSecretVersionStageWithContext(ctx aws.Context, input *UpdateSecretVersionStageInput, opts ...request.Option) (*UpdateSecretVersionStageOutput, error)

UpdateSecretVersionStageWithContext is the same as UpdateSecretVersionStage with the addition of the ability to pass a context and additional request options.

See UpdateSecretVersionStage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecretsManager) UpdateSecretWithContext 

func (c *SecretsManager) UpdateSecretWithContext(ctx aws.Context, input *UpdateSecretInput, opts ...request.Option) (*UpdateSecretOutput, error)

UpdateSecretWithContext is the same as UpdateSecret with the addition of the ability to pass a context and additional request options.

See UpdateSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Tag 

type Tag struct {

	// The key identifier, or name, of the tag.
	Key *string `min:"1" type:"string"`

	// The string value that's associated with the key of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about a tag.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// 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 information
	// on how to format a JSON parameter for the various command line tool environments,
	// see Using JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax:
	// --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…]
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetSecretId 

func (s *TagResourceInput) SetSecretId(v string) *TagResourceInput

SetSecretId sets the SecretId field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput 

type UntagResourceInput struct {

	// 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// 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 information
	// on how to format a JSON parameter for the various command line tool environments,
	// see Using JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS CLI User Guide.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetSecretId 

func (s *UntagResourceInput) SetSecretId(v string) *UntagResourceInput

SetSecretId sets the SecretId field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateSecretInput 

type UpdateSecretInput struct {

	// (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 AWS CLI or one of the AWS 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 (https://wikipedia.org/wiki/Universally_unique_identifier)
	// 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 SecretVersionId of the new version.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// (Optional) Specifies a user-provided description of the secret.
	Description *string `type:"string"`

	// (Optional) Specifies the ARN or alias of the KMS customer master key (CMK)
	// to be used to encrypt the protected text in the versions of this secret.
	//
	// If you don't specify this value, then Secrets Manager defaults to using the
	// default CMK in the account (the one named aws/secretsmanager). If a KMS CMK
	// with that name doesn't exist, then Secrets Manager creates it for you automatically
	// the first time it needs to encrypt a version's Plaintext or PlaintextString
	// fields.
	//
	// 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 in this field.
	KmsKeyId *string `type:"string"`

	// (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 using the Secrets Manager console.
	//
	// SecretBinary is automatically base64 encoded/decoded by the SDK.
	SecretBinary []byte `type:"blob"`

	// Specifies the secret that you want to update 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.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// (Optional) Specifies 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 information on how to format a
	// JSON parameter for the various command line tool environments, see Using
	// JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json)
	// in the AWS CLI User Guide. For example:
	//
	// [{"username":"bob"},{"password":"abc123xyz456"}]
	//
	// 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.
	SecretString *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSecretInput) GoString 

func (s UpdateSecretInput) GoString() string

GoString returns the string representation

func (*UpdateSecretInput) SetClientRequestToken 

func (s *UpdateSecretInput) SetClientRequestToken(v string) *UpdateSecretInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateSecretInput) SetDescription 

func (s *UpdateSecretInput) SetDescription(v string) *UpdateSecretInput

SetDescription sets the Description field's value.

func (*UpdateSecretInput) SetKmsKeyId 

func (s *UpdateSecretInput) SetKmsKeyId(v string) *UpdateSecretInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateSecretInput) SetSecretBinary 

func (s *UpdateSecretInput) SetSecretBinary(v []byte) *UpdateSecretInput

SetSecretBinary sets the SecretBinary field's value.

func (*UpdateSecretInput) SetSecretId 

func (s *UpdateSecretInput) SetSecretId(v string) *UpdateSecretInput

SetSecretId sets the SecretId field's value.

func (*UpdateSecretInput) SetSecretString 

func (s *UpdateSecretInput) SetSecretString(v string) *UpdateSecretInput

SetSecretString sets the SecretString field's value.

func (UpdateSecretInput) String 

func (s UpdateSecretInput) String() string

String returns the string representation

func (*UpdateSecretInput) Validate 

func (s *UpdateSecretInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSecretOutput 

type UpdateSecretOutput struct {

	// The ARN of this 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.
	ARN *string `min:"20" type:"string"`

	// The friendly name of this secret.
	Name *string `min:"1" type:"string"`

	// If a version of the secret was created or updated by this operation, then
	// its unique identifier is returned.
	VersionId *string `min:"32" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSecretOutput) GoString 

func (s UpdateSecretOutput) GoString() string

GoString returns the string representation

func (*UpdateSecretOutput) SetARN 

func (s *UpdateSecretOutput) SetARN(v string) *UpdateSecretOutput

SetARN sets the ARN field's value.

func (*UpdateSecretOutput) SetName 

func (s *UpdateSecretOutput) SetName(v string) *UpdateSecretOutput

SetName sets the Name field's value.

func (*UpdateSecretOutput) SetVersionId 

func (s *UpdateSecretOutput) SetVersionId(v string) *UpdateSecretOutput

SetVersionId sets the VersionId field's value.

func (UpdateSecretOutput) String 

func (s UpdateSecretOutput) String() string

String returns the string representation

type UpdateSecretVersionStageInput 

type UpdateSecretVersionStageInput struct {

	// (Optional) The secret version ID that you want to add the staging labels
	// to.
	//
	// If any of the staging labels are already attached to a different version
	// of the secret, then they are removed from that version before adding them
	// to this version.
	MoveToVersionId *string `min:"32" type:"string"`

	// (Optional) Specifies the secret version ID of the version that the staging
	// labels are to be removed from.
	//
	// If you want to move a label to a new version, you do not have to explicitly
	// remove it with this parameter. Adding a label using the MoveToVersionId parameter
	// automatically removes it from the old version. However, if you do include
	// both the "MoveTo" and "RemoveFrom" parameters, then the move is successful
	// only if the staging labels are actually present on the "RemoveFrom" version.
	// If a staging label was on a different version than "RemoveFrom", then the
	// request fails.
	RemoveFromVersionId *string `min:"32" type:"string"`

	// Specifies the secret with the version whose list of staging labels you want
	// to modify. You can specify either the Amazon Resource Name (ARN) or the friendly
	// name of the secret.
	//
	// SecretId is a required field
	SecretId *string `min:"1" type:"string" required:"true"`

	// The list of staging labels to add to this version.
	//
	// VersionStage is a required field
	VersionStage *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSecretVersionStageInput) GoString 

func (s UpdateSecretVersionStageInput) GoString() string

GoString returns the string representation

func (*UpdateSecretVersionStageInput) SetMoveToVersionId 

func (s *UpdateSecretVersionStageInput) SetMoveToVersionId(v string) *UpdateSecretVersionStageInput

SetMoveToVersionId sets the MoveToVersionId field's value.

func (*UpdateSecretVersionStageInput) SetRemoveFromVersionId 

func (s *UpdateSecretVersionStageInput) SetRemoveFromVersionId(v string) *UpdateSecretVersionStageInput

SetRemoveFromVersionId sets the RemoveFromVersionId field's value.

func (*UpdateSecretVersionStageInput) SetSecretId 

func (s *UpdateSecretVersionStageInput) SetSecretId(v string) *UpdateSecretVersionStageInput

SetSecretId sets the SecretId field's value.

func (*UpdateSecretVersionStageInput) SetVersionStage 

func (s *UpdateSecretVersionStageInput) SetVersionStage(v string) *UpdateSecretVersionStageInput

SetVersionStage sets the VersionStage field's value.

func (UpdateSecretVersionStageInput) String 

func (s UpdateSecretVersionStageInput) String() string

String returns the string representation

func (*UpdateSecretVersionStageInput) Validate 

func (s *UpdateSecretVersionStageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSecretVersionStageOutput 

type UpdateSecretVersionStageOutput struct {

	// The ARN of the secret with the staging labels that were modified.
	ARN *string `min:"20" type:"string"`

	// The friendly name of the secret with the staging labels that were modified.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSecretVersionStageOutput) GoString 

func (s UpdateSecretVersionStageOutput) GoString() string

GoString returns the string representation

func (*UpdateSecretVersionStageOutput) SetARN 

func (s *UpdateSecretVersionStageOutput) SetARN(v string) *UpdateSecretVersionStageOutput

SetARN sets the ARN field's value.

func (*UpdateSecretVersionStageOutput) SetName 

func (s *UpdateSecretVersionStageOutput) SetName(v string) *UpdateSecretVersionStageOutput

SetName sets the Name field's value.

func (UpdateSecretVersionStageOutput) String 

func (s UpdateSecretVersionStageOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package secretsmanageriface provides an interface to enable mocking the AWS Secrets Manager service client for testing your code.
 Package secretsmanageriface provides an interface to enable mocking the AWS Secrets Manager service client for testing your code.

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.