-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_CreateIndex.go
239 lines (216 loc) · 8.63 KB
/
api_op_CreateIndex.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
232
233
234
235
236
237
238
239
// Code generated by smithy-go-codegen DO NOT EDIT.
package resourceexplorer2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/resourceexplorer2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Turns on Amazon Web Services Resource Explorer in the Amazon Web Services
// Region in which you called this operation by creating an index. Resource
// Explorer begins discovering the resources in this Region and stores the details
// about the resources in the index so that they can be queried by using the Search
// operation. You can create only one index in a Region.
//
// This operation creates only a local index. To promote the local index in one
// Amazon Web Services Region into the aggregator index for the Amazon Web Services
// account, use the UpdateIndexTypeoperation. For more information, see [Turning on cross-Region search by creating an aggregator index] in the Amazon Web
// Services Resource Explorer User Guide.
//
// For more details about what happens when you turn on Resource Explorer in an
// Amazon Web Services Region, see [Turn on Resource Explorer to index your resources in an Amazon Web Services Region]in the Amazon Web Services Resource Explorer
// User Guide.
//
// If this is the first Amazon Web Services Region in which you've created an
// index for Resource Explorer, then this operation also [creates a service-linked role]in your Amazon Web
// Services account that allows Resource Explorer to enumerate your resources to
// populate the index.
//
// - Action: resource-explorer-2:CreateIndex
//
// Resource: The ARN of the index (as it will exist after the operation completes)
//
// in the Amazon Web Services Region and account in which you're trying to create
// the index. Use the wildcard character ( * ) at the end of the string to match
// the eventual UUID. For example, the following Resource element restricts the
// role or user to creating an index in only the us-east-2 Region of the
// specified account.
//
// "Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*"
//
// Alternatively, you can use "Resource": "*" to allow the role or user to create
//
// an index in any Region.
//
// - Action: iam:CreateServiceLinkedRole
//
// Resource: No specific resource (*).
//
// This permission is required only the first time you create an index to turn on
//
// Resource Explorer in the account. Resource Explorer uses this to create the [service-linked role needed to index the resources in your account].
// Resource Explorer uses the same service-linked role for all additional indexes
// you create afterwards.
//
// [Turning on cross-Region search by creating an aggregator index]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
// [creates a service-linked role]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html
// [Turn on Resource Explorer to index your resources in an Amazon Web Services Region]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html
//
// [service-linked role needed to index the resources in your account]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html
func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) {
if params == nil {
params = &CreateIndexInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateIndex", params, optFns, c.addOperationCreateIndexMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateIndexOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateIndexInput struct {
// This value helps ensure idempotency. Resource Explorer uses this value to
// prevent the accidental creation of duplicate versions. We recommend that you
// generate a [UUID-type value]to ensure the uniqueness of your index.
//
// [UUID-type value]: https://wikipedia.org/wiki/Universally_unique_identifier
ClientToken *string
// The specified tags are attached only to the index created in this Amazon Web
// Services Region. The tags aren't attached to any of the resources listed in the
// index.
Tags map[string]string
noSmithyDocumentSerde
}
type CreateIndexOutput struct {
// The ARN of the new local index for the Region. You can reference this ARN in
// IAM permission policies to authorize the following operations: DeleteIndex| GetIndex | UpdateIndexType | CreateView
Arn *string
// The date and timestamp when the index was created.
CreatedAt *time.Time
// Indicates the current state of the index. You can check for changes to the
// state for asynchronous operations by calling the GetIndexoperation.
//
// The state can remain in the CREATING or UPDATING state for several hours as
// Resource Explorer discovers the information about your resources and populates
// the index.
State types.IndexState
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateIndexMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateIndex{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateIndex{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateIndex"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addIdempotencyToken_opCreateIndexMiddleware(stack, options); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateIndex(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
type idempotencyToken_initializeOpCreateIndex struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateIndex) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateIndex) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateIndexInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateIndexInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateIndexMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateIndex{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateIndex(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateIndex",
}
}