-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_DescribeSecret.go
231 lines (201 loc) · 8.35 KB
/
api_op_DescribeSecret.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
// Code generated by smithy-go-codegen DO NOT EDIT.
package secretsmanager
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Retrieves the details of a secret. It does not include the encrypted secret
// value. Secrets Manager only returns fields that have a value in the response.
// Secrets Manager generates a CloudTrail log entry when you call this action. Do
// not include sensitive information in request parameters because it might be
// logged. For more information, see Logging Secrets Manager events with CloudTrail
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html).
// Required permissions: secretsmanager:DescribeSecret. For more information, see
// IAM policy actions for Secrets Manager
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions)
// and Authentication and access control in Secrets Manager
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).
func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error) {
if params == nil {
params = &DescribeSecretInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeSecret", params, optFns, c.addOperationDescribeSecretMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeSecretOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeSecretInput struct {
// The ARN or name of the secret. For an ARN, we recommend that you specify a
// complete ARN rather than a partial ARN. See Finding a secret from a partial ARN
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen).
//
// This member is required.
SecretId *string
noSmithyDocumentSerde
}
type DescribeSecretOutput struct {
// The ARN of the secret.
ARN *string
// The date the secret was created.
CreatedDate *time.Time
// The date the secret is scheduled for deletion. If it is not scheduled for
// deletion, this field is omitted. When you delete a secret, Secrets Manager
// requires a recovery window of at least 7 days before deleting the secret. Some
// time after the deleted date, Secrets Manager deletes the secret, including all
// of its versions. If a secret is scheduled for deletion, then its details,
// including the encrypted secret value, is not accessible. To cancel a scheduled
// deletion and restore access to the secret, use RestoreSecret.
DeletedDate *time.Time
// The description of the secret.
Description *string
// The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the
// secret value. If the secret is encrypted with the Amazon Web Services managed
// key aws/secretsmanager, this field is omitted. Secrets created using the console
// use an KMS key ID.
KmsKeyId *string
// The date that the secret was last accessed in the Region. This field is omitted
// if the secret has never been retrieved in the Region.
LastAccessedDate *time.Time
// The last date and time that this secret was modified in any way.
LastChangedDate *time.Time
// The last date and time that Secrets Manager rotated the secret. If the secret
// isn't configured for rotation, Secrets Manager returns null.
LastRotatedDate *time.Time
// The name of the secret.
Name *string
// The ID of the service that created this secret. For more information, see
// Secrets managed by other Amazon Web Services services
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html).
OwningService *string
// The Region the secret is in. If a secret is replicated to other Regions, the
// replicas are listed in ReplicationStatus.
PrimaryRegion *string
// A list of the replicas of this secret and their status:
//
// * Failed, which
// indicates that the replica was not created.
//
// * InProgress, which indicates that
// Secrets Manager is in the process of creating the replica.
//
// * InSync, which
// indicates that the replica was created.
ReplicationStatus []types.ReplicationStatusType
// Specifies whether automatic rotation is turned on for this secret. To turn on
// rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
RotationEnabled *bool
// The ARN of the Lambda function that Secrets Manager invokes to rotate the
// secret.
RotationLambdaARN *string
// The rotation schedule and Lambda function for this secret. If the secret
// previously had rotation turned on, but it is now turned off, this field shows
// the previous rotation schedule and rotation function. If the secret never had
// rotation turned on, this field is omitted.
RotationRules *types.RotationRulesType
// The list of tags attached to the secret. To add tags to a secret, use
// TagResource. To remove tags, use UntagResource.
Tags []types.Tag
// A list of the versions of the secret that have staging labels attached. Versions
// that don't have staging labels are considered deprecated and Secrets Manager can
// delete them. Secrets Manager uses staging labels to indicate the status of a
// secret version during rotation. The three staging labels for rotation are:
//
// *
// AWSCURRENT, which indicates the current version of the secret.
//
// * AWSPENDING,
// which indicates the version of the secret that contains new secret information
// that will become the next current version when rotation finishes. During
// rotation, Secrets Manager creates an AWSPENDING version ID before creating the
// new secret version. To check if a secret version exists, call GetSecretValue.
//
// *
// AWSPREVIOUS, which indicates the previous current version of the secret. You can
// use this as the last known good version.
//
// For more information about rotation
// and staging labels, see How rotation works
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html).
VersionIdsToStages map[string][]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeSecretMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeSecret{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeSecret{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeSecretValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSecret(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeSecret(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "secretsmanager",
OperationName: "DescribeSecret",
}
}