| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ResourceExplorer2.CreateIndex
Description
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:CreateIndexResource: 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 followingResourceelement restricts the role or user to creating an index in only theus-east-2Region 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:CreateServiceLinkedRoleResource: 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.
Synopsis
- data CreateIndex = CreateIndex' {}
- newCreateIndex :: CreateIndex
- createIndex_clientToken :: Lens' CreateIndex (Maybe Text)
- createIndex_tags :: Lens' CreateIndex (Maybe (HashMap Text Text))
- data CreateIndexResponse = CreateIndexResponse' {}
- newCreateIndexResponse :: Int -> CreateIndexResponse
- createIndexResponse_arn :: Lens' CreateIndexResponse (Maybe Text)
- createIndexResponse_createdAt :: Lens' CreateIndexResponse (Maybe UTCTime)
- createIndexResponse_state :: Lens' CreateIndexResponse (Maybe IndexState)
- createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int
Creating a Request
data CreateIndex Source #
See: newCreateIndex smart constructor.
Constructors
| CreateIndex' | |
Fields
| |
Instances
newCreateIndex :: CreateIndex Source #
Create a value of CreateIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateIndex', createIndex_clientToken - 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 views.
$sel:tags:CreateIndex', createIndex_tags - 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.
Request Lenses
createIndex_clientToken :: Lens' CreateIndex (Maybe Text) Source #
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 views.
createIndex_tags :: Lens' CreateIndex (Maybe (HashMap Text Text)) Source #
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.
Destructuring the Response
data CreateIndexResponse Source #
See: newCreateIndexResponse smart constructor.
Constructors
| CreateIndexResponse' | |
Fields
| |
Instances
newCreateIndexResponse Source #
Arguments
| :: Int | |
| -> CreateIndexResponse |
Create a value of CreateIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateIndexResponse, createIndexResponse_arn - 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
$sel:createdAt:CreateIndexResponse', createIndexResponse_createdAt - The date and timestamp when the index was created.
$sel:state:CreateIndexResponse', createIndexResponse_state - Indicates the current state of the index. You can check for changes to
the state for asynchronous operations by calling the GetIndex operation.
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.
$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.
Response Lenses
createIndexResponse_arn :: Lens' CreateIndexResponse (Maybe Text) Source #
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
createIndexResponse_createdAt :: Lens' CreateIndexResponse (Maybe UTCTime) Source #
The date and timestamp when the index was created.
createIndexResponse_state :: Lens' CreateIndexResponse (Maybe IndexState) Source #
Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the GetIndex operation.
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.
createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int Source #
The response's http status code.