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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cognitoidentityprovider
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// This IAM-authenticated API operation provides a code that Amazon Cognito sent
// to your user when they signed up in your user pool. After your user enters their
// code, they confirm ownership of the email address or phone number that they
// provided, and their user account becomes active. Depending on your user pool
// configuration, your users will receive their confirmation code in an email or
// SMS message. Local users who signed up in your user pool are the only type of
// user who can confirm sign-up with a code. Users who federate through an external
// identity provider (IdP) have already been confirmed by their IdP.
// Administrator-created users confirm their accounts when they respond to their
// invitation email message and choose a password. Amazon Cognito evaluates
// Identity and Access Management (IAM) policies in requests for this API
// operation. For this operation, you must use IAM credentials to authorize
// requests, and you must grant yourself the corresponding IAM permission in a
// policy. Learn more
// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
func (c *Client) AdminConfirmSignUp(ctx context.Context, params *AdminConfirmSignUpInput, optFns ...func(*Options)) (*AdminConfirmSignUpOutput, error) {
if params == nil {
params = &AdminConfirmSignUpInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AdminConfirmSignUp", params, optFns, c.addOperationAdminConfirmSignUpMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AdminConfirmSignUpOutput)
out.ResultMetadata = metadata
return out, nil
}
// Confirm a user's registration as a user pool administrator.
type AdminConfirmSignUpInput struct {
// The user pool ID for which you want to confirm user registration.
//
// This member is required.
UserPoolId *string
// The username of the user that you want to query or modify. The value of this
// parameter is typically your user's username, but it can be any of their alias
// attributes. If username isn't an alias attribute in your user pool, you can
// also use their sub in this request.
//
// This member is required.
Username *string
// A map of custom key-value pairs that you can provide as input for any custom
// workflows that this action triggers. If your user pool configuration includes
// triggers, the AdminConfirmSignUp API action invokes the Lambda function that is
// specified for the post confirmation trigger. When Amazon Cognito invokes this
// function, it passes a JSON payload, which the function receives as input. In
// this payload, the clientMetadata attribute provides the data that you assigned
// to the ClientMetadata parameter in your AdminConfirmSignUp request. In your
// function code in Lambda, you can process the ClientMetadata value to enhance
// your workflow for your specific needs. For more information, see Customizing
// user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
// in the Amazon Cognito Developer Guide. When you use the ClientMetadata
// parameter, remember that Amazon Cognito won't do the following:
// - Store the ClientMetadata value. This data is available only to Lambda
// triggers that are assigned to a user pool to support custom workflows. If your
// user pool configuration doesn't include triggers, the ClientMetadata parameter
// serves no purpose.
// - Validate the ClientMetadata value.
// - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
// sensitive information.
ClientMetadata map[string]string
noSmithyDocumentSerde
}
// Represents the response from the server for the request to confirm registration.
type AdminConfirmSignUpOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAdminConfirmSignUpMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpAdminConfirmSignUp{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpAdminConfirmSignUp{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "AdminConfirmSignUp"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpAdminConfirmSignUpValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAdminConfirmSignUp(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAdminConfirmSignUp(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "AdminConfirmSignUp",
}
}
|
