AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 UpdateIndexType operation. 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:
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateIndex and EndCreateIndex.
Namespace: Amazon.ResourceExplorer2
Assembly: AWSSDK.ResourceExplorer2.dll
Version: 3.x.y.z
public virtual Task<CreateIndexResponse> CreateIndexAsync( CreateIndexRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateIndex service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | The credentials that you used to call this operation don't have the minimum required permissions. |
| ConflictException | If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region. If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region. If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region. |
| InternalServerException | The request failed because of internal service error. Try your request again later. |
| ThrottlingException | The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer. |
| ValidationException | You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer