Struct aws_sdk_resourceexplorer2::Client

pub struct Client { /* private fields */ }

Client for AWS Resource Explorer

Client for invoking operations on AWS Resource Explorer. Each operation on AWS Resource Explorer is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_resourceexplorer2::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_resourceexplorer2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ListSupportedResourceTypes operation has a Client::list_supported_resource_types, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.list_supported_resource_types()
    .next_token("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_default_view(&self) -> AssociateDefaultViewFluentBuilder

Constructs a fluent builder for the AssociateDefaultView operation.

• The fluent builder is configurable:
  • view_arn(impl Into<String>) / set_view_arn(Option<String>):

    The Amazon resource name (ARN) of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.

• On success, responds with AssociateDefaultViewOutput with field(s):
  • view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.

• On failure, responds with SdkError<AssociateDefaultViewError>

impl Client

pub fn batch_get_view(&self) -> BatchGetViewFluentBuilder

Constructs a fluent builder for the BatchGetView operation.

• The fluent builder is configurable:
  • view_arns(Vec<String>) / set_view_arns(Option<Vec<String>>):

    A list of Amazon resource names (ARNs) that identify the views you want details for.

• On success, responds with BatchGetViewOutput with field(s):
  • views(Option<Vec<View>>):

    A structure with a list of objects with details for each of the specified views.

  • errors(Option<Vec<BatchGetViewError>>):

    If any of the specified ARNs result in an error, then this structure describes the error.

• On failure, responds with SdkError<BatchGetViewError>

impl Client

pub fn create_index(&self) -> CreateIndexFluentBuilder

Constructs a fluent builder for the CreateIndex operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    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.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, 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.

• On success, responds with CreateIndexOutput with field(s):
  • arn(Option<String>):

    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

  • state(Option<IndexState>):

    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.

  • created_at(Option<DateTime>):

    The date and timestamp when the index was created.

• On failure, responds with SdkError<CreateIndexError>

impl Client

pub fn create_view(&self) -> CreateViewFluentBuilder

Constructs a fluent builder for the CreateView operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    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.

  • view_name(impl Into<String>) / set_view_name(Option<String>):

    The name of the new view. This name appears in the list of views in Resource Explorer.

    The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.

  • included_properties(Vec<IncludedProperty>) / set_included_properties(Option<Vec<IncludedProperty>>):

    Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

    The default is an empty list, with no optional fields included in the results.

  • filters(SearchFilter) / set_filters(Option<SearchFilter>):

    An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search’s QueryString parameter using a logical AND operator.

    For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.

    This query string in the context of this operation supports only filter prefixes with optional operators. It doesn’t support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Tag key and value pairs that are attached to the view.

• On success, responds with CreateViewOutput with field(s):
  • view(Option<View>):

    A structure that contains the details about the new view.

• On failure, responds with SdkError<CreateViewError>

impl Client

pub fn delete_index(&self) -> DeleteIndexFluentBuilder

Constructs a fluent builder for the DeleteIndex operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    The Amazon resource name (ARN) of the index that you want to delete.

• On success, responds with DeleteIndexOutput with field(s):
  • arn(Option<String>):

    The Amazon resource name (ARN) of the index that you successfully started the deletion process.

    This operation is asynchronous. To check its status, call the GetIndex operation.

  • state(Option<IndexState>):

    Indicates the current state of the index.

  • last_updated_at(Option<DateTime>):

    The date and time when you last updated this index.

• On failure, responds with SdkError<DeleteIndexError>

impl Client

pub fn delete_view(&self) -> DeleteViewFluentBuilder

Constructs a fluent builder for the DeleteView operation.

• The fluent builder is configurable:
  • view_arn(impl Into<String>) / set_view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that you want to delete.

• On success, responds with DeleteViewOutput with field(s):
  • view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that you successfully deleted.

• On failure, responds with SdkError<DeleteViewError>

impl Client

pub fn disassociate_default_view(&self) -> DisassociateDefaultViewFluentBuilder

Constructs a fluent builder for the DisassociateDefaultView operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisassociateDefaultViewOutput
• On failure, responds with SdkError<DisassociateDefaultViewError>

impl Client

pub fn get_default_view(&self) -> GetDefaultViewFluentBuilder

Constructs a fluent builder for the GetDefaultView operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetDefaultViewOutput with field(s):
  • view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that is the current default for the Amazon Web Services Region in which you called this operation.

• On failure, responds with SdkError<GetDefaultViewError>

impl Client

pub fn get_index(&self) -> GetIndexFluentBuilder

Constructs a fluent builder for the GetIndex operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetIndexOutput with field(s):
  • arn(Option<String>):

    The Amazon resource name (ARN) of the index.

  • r#type(Option<IndexType>):

    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.

  • state(Option<IndexState>):

    The current state of the index in this Amazon Web Services Region.

  • replicating_from(Option<Vec<String>>):

    This response value is present only if this index is Type=AGGREGATOR.

    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

  • replicating_to(Option<Vec<String>>):

    This response value is present only if this index is Type=LOCAL.

    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

  • created_at(Option<DateTime>):

    The date and time when the index was originally created.

  • last_updated_at(Option<DateTime>):

    The date and time when the index was last updated.

  • tags(Option<HashMap<String, String>>):

    Tag key and value pairs that are attached to the index.

• On failure, responds with SdkError<GetIndexError>

impl Client

pub fn get_view(&self) -> GetViewFluentBuilder

Constructs a fluent builder for the GetView operation.

• The fluent builder is configurable:
  • view_arn(impl Into<String>) / set_view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that you want information about.

• On success, responds with GetViewOutput with field(s):
  • view(Option<View>):

    A structure that contains the details for the requested view.

  • tags(Option<HashMap<String, String>>):

    Tag key and value pairs that are attached to the view.

• On failure, responds with SdkError<GetViewError>

impl Client

pub fn list_indexes(&self) -> ListIndexesFluentBuilder

Constructs a fluent builder for the ListIndexes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • r#type(IndexType) / set_type(Option<IndexType>):

    If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

    Use this option to discover the aggregator index for your account.

  • regions(Vec<String>) / set_regions(Option<Vec<String>>):

    If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

• On success, responds with ListIndexesOutput with field(s):
  • indexes(Option<Vec<Index>>):

    A structure that contains the details and status of each index.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListIndexesError>

impl Client

pub fn list_supported_resource_types( &self ) -> ListSupportedResourceTypesFluentBuilder

Constructs a fluent builder for the ListSupportedResourceTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• On success, responds with ListSupportedResourceTypesOutput with field(s):
  • resource_types(Option<Vec<SupportedResourceType>>):

    The list of resource types supported by Resource Explorer.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListSupportedResourceTypesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon resource name (ARN) of the view or index that you want to attach tags to.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The tag key and value pairs that you want to attach to the specified view or index.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_views(&self) -> ListViewsFluentBuilder

Constructs a fluent builder for the ListViews operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• On success, responds with ListViewsOutput with field(s):
  • views(Option<Vec<String>>):

    The list of views available in the Amazon Web Services Region in which you called this operation.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListViewsError>

impl Client

pub fn search(&self) -> SearchFluentBuilder

Constructs a fluent builder for the Search operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • query_string(impl Into<String>) / set_query_string(Option<String>):

    A string that includes keywords and filters that specify the resources that you want to include in the results.

    For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

    The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.

    The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • view_arn(impl Into<String>) / set_view_arn(Option<String>):

    Specifies the Amazon resource name (ARN) of the view to use for the query. If you don’t specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn’t have a default view or if you don’t have permission to use the default view, then the operation fails with a 401 Unauthorized exception.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

• On success, responds with SearchOutput with field(s):
  • resources(Option<Vec<Resource>>):

    The list of structures that describe the resources that match the query.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that this operation used to perform the search.

  • count(Option<ResourceCount>):

    The number of resources that match the query.

• On failure, responds with SdkError<SearchError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A list of tag key and value pairs that you want to attach to the specified view or index.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of the keys for the tags that you want to remove from the specified view or index.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_index_type(&self) -> UpdateIndexTypeFluentBuilder

Constructs a fluent builder for the UpdateIndexType operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    The Amazon resource name (ARN) of the index that you want to update.

  • r#type(IndexType) / set_type(Option<IndexType>):

    The type of the index. To understand the difference between LOCAL and AGGREGATOR, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.

• On success, responds with UpdateIndexTypeOutput with field(s):
  • arn(Option<String>):

    The Amazon resource name (ARN) of the index that you updated.

  • r#type(Option<IndexType>):

    Specifies the type of the specified index after the operation completes.

  • state(Option<IndexState>):

    Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.

  • last_updated_at(Option<DateTime>):

    The date and timestamp when the index was last updated.

• On failure, responds with SdkError<UpdateIndexTypeError>

impl Client

pub fn update_view(&self) -> UpdateViewFluentBuilder

Constructs a fluent builder for the UpdateView operation.

• The fluent builder is configurable:
  • view_arn(impl Into<String>) / set_view_arn(Option<String>):

    The Amazon resource name (ARN) of the view that you want to modify.

  • included_properties(Vec<IncludedProperty>) / set_included_properties(Option<Vec<IncludedProperty>>):

    Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

    The default is an empty list, with no optional fields included in the results.

  • filters(SearchFilter) / set_filters(Option<SearchFilter>):

    An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search’s QueryString parameter using a logical AND operator.

    For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.

    This query string in the context of this operation supports only filter prefixes with optional operators. It doesn’t support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.

• On success, responds with UpdateViewOutput with field(s):
  • view(Option<View>):

    Details about the view that you changed with this operation.

• On failure, responds with SdkError<UpdateViewError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.