aws_sdk_resourceexplorer2/client/
create_index.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateIndex`](crate::operation::create_index::builders::CreateIndexFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::set_client_token):<br>required: **false**<br><p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type value</a> to ensure the uniqueness of your index.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::set_tags):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`CreateIndexOutput`](crate::operation::create_index::CreateIndexOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::create_index::CreateIndexOutput::arn): <p>The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: <code>DeleteIndex</code> | <code>GetIndex</code> | <code>UpdateIndexType</code> | <code>CreateView</code></p>
    ///   - [`state(Option<IndexState>)`](crate::operation::create_index::CreateIndexOutput::state): <p>Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the <code>GetIndex</code> operation.</p><note>  <p>The state can remain in the <code>CREATING</code> or <code>UPDATING</code> state for several hours as Resource Explorer discovers the information about your resources and populates the index.</p> </note>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_index::CreateIndexOutput::created_at): <p>The date and timestamp when the index was created.</p>
    /// - On failure, responds with [`SdkError<CreateIndexError>`](crate::operation::create_index::CreateIndexError)
    pub fn create_index(&self) -> crate::operation::create_index::builders::CreateIndexFluentBuilder {
        crate::operation::create_index::builders::CreateIndexFluentBuilder::new(self.handle.clone())
    }
}