Class: Aws::ResourceExplorer2::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-resourceexplorer2/client.rb

Overview

An API client for ResourceExplorer2. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::ResourceExplorer2::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ResourceExplorer2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ResourceExplorer2::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



467
468
469
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1905
1906
1907
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1905

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1908
1909
1910
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1908

def errors_module
  Errors
end

Instance Method Details

#associate_default_view(params = {}) ⇒ Types::AssociateDefaultViewOutput

Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn’t explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.

If an Amazon Web Services Region doesn’t have a default view configured, then users must explicitly specify a view with every ‘Search` operation performed in that Region.

Examples:

Request syntax with placeholder values


resp = client.associate_default_view({
  view_arn: "AssociateDefaultViewInputViewArnString", # required
})

Response structure


resp.view_arn #=> String

Options Hash (params):

See Also:



511
512
513
514
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 511

def associate_default_view(params = {}, options = {})
  req = build_request(:associate_default_view, params)
  req.send_request(options)
end

#batch_get_view(params = {}) ⇒ Types::BatchGetViewOutput

Retrieves details about a list of views.

Examples:

Request syntax with placeholder values


resp = client.batch_get_view({
  view_arns: ["String"],
})

Response structure


resp.errors #=> Array
resp.errors[0].error_message #=> String
resp.errors[0].view_arn #=> String
resp.views #=> Array
resp.views[0].filters.filter_string #=> String
resp.views[0].included_properties #=> Array
resp.views[0].included_properties[0].name #=> String
resp.views[0].last_updated_at #=> Time
resp.views[0].owner #=> String
resp.views[0].scope #=> String
resp.views[0].view_arn #=> String

Options Hash (params):

See Also:



555
556
557
558
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 555

def batch_get_view(params = {}, options = {})
  req = build_request(:batch_get_view, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1878

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ResourceExplorer2')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-resourceexplorer2'
  context[:gem_version] = '1.32.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_index(params = {}) ⇒ Types::CreateIndexOutput

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.

<note markdown=“1”> 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*.

</note>

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][3

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.

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html [2]: docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html [3]: docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html

Examples:

Request syntax with placeholder values


resp = client.create_index({
  client_token: "String",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"

Options Hash (params):

  • :client_token (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 index.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :tags (Hash<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.

See Also:



663
664
665
666
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 663

def create_index(params = {}, options = {})
  req = build_request(:create_index, params)
  req.send_request(options)
end

#create_view(params = {}) ⇒ Types::CreateViewOutput

Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view’s ‘Filters`. For more information about Amazon Web Services Resource Explorer views, see [Managing views] in the *Amazon Web Services Resource Explorer User Guide*.

Only the principals with an IAM identity-based policy that grants ‘Allow` to the `Search` action on a `Resource` with the [Amazon resource name (ARN)] of this view can Search using views you create with this operation.

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Examples:

Request syntax with placeholder values


resp = client.create_view({
  client_token: "CreateViewInputClientTokenString",
  filters: {
    filter_string: "SearchFilterFilterStringString", # required
  },
  included_properties: [
    {
      name: "IncludedPropertyNameString", # required
    },
  ],
  scope: "CreateViewInputScopeString",
  tags: {
    "String" => "String",
  },
  view_name: "ViewName", # required
})

Response structure


resp.view.filters.filter_string #=> String
resp.view.included_properties #=> Array
resp.view.included_properties[0].name #=> String
resp.view.last_updated_at #=> Time
resp.view.owner #=> String
resp.view.scope #=> String
resp.view.view_arn #=> String

Options Hash (params):

  • :client_token (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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :filters (Types::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][2

    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`.

    [1]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html [2]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters [3]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators

  • :included_properties (Array<Types::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.

  • :scope (String) —

    The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.

  • :tags (Hash<String,String>) —

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

  • :view_name (required, 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.

See Also:



780
781
782
783
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 780

def create_view(params = {}, options = {})
  req = build_request(:create_view, params)
  req.send_request(options)
end

#delete_index(params = {}) ⇒ Types::DeleteIndexOutput

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the ‘Status` response value.

<note markdown=“1”> If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can’t perform account-wide searches using Resource Explorer until another aggregator index is configured.

</note>

Examples:

Request syntax with placeholder values


resp = client.delete_index({
  arn: "String", # required
})

Response structure


resp.arn #=> String
resp.last_updated_at #=> Time
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"

Options Hash (params):

See Also:



831
832
833
834
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 831

def delete_index(params = {}, options = {})
  req = build_request(:delete_index, params)
  req.send_request(options)
end

#delete_view(params = {}) ⇒ Types::DeleteViewOutput

Deletes the specified view.

If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.

Examples:

Request syntax with placeholder values


resp = client.delete_view({
  view_arn: "DeleteViewInputViewArnString", # required
})

Response structure


resp.view_arn #=> String

Options Hash (params):

See Also:



869
870
871
872
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 869

def delete_view(params = {}, options = {})
  req = build_request(:delete_view, params)
  req.send_request(options)
end

#disassociate_default_view(params = {}) ⇒ Struct

After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

If an Amazon Web Services Region doesn’t have a default view configured, then users must explicitly specify a view with every ‘Search` operation performed in that Region.

See Also:



889
890
891
892
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 889

def disassociate_default_view(params = {}, options = {})
  req = build_request(:disassociate_default_view, params)
  req.send_request(options)
end

#get_account_level_service_configuration(params = {}) ⇒ Types::GetAccountLevelServiceConfigurationOutput

Retrieves the status of your account’s Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call.

Examples:

Response structure


resp.org_configuration.aws_service_access_status #=> String, one of "ENABLED", "DISABLED"
resp.org_configuration.service_linked_role #=> String

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 912

def (params = {}, options = {})
  req = build_request(:get_account_level_service_configuration, params)
  req.send_request(options)
end

#get_default_view(params = {}) ⇒ Types::GetDefaultViewOutput

Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.

Examples:

Response structure


resp.view_arn #=> String

See Also:



934
935
936
937
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 934

def get_default_view(params = {}, options = {})
  req = build_request(:get_default_view, params)
  req.send_request(options)
end

#get_index(params = {}) ⇒ Types::GetIndexOutput

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Examples:

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.replicating_from #=> Array
resp.replicating_from[0] #=> String
resp.replicating_to #=> Array
resp.replicating_to[0] #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.type #=> String, one of "LOCAL", "AGGREGATOR"

See Also:



972
973
974
975
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 972

def get_index(params = {}, options = {})
  req = build_request(:get_index, params)
  req.send_request(options)
end

#get_managed_view(params = {}) ⇒ Types::GetManagedViewOutput

Retrieves details of the specified [Amazon Web Services-managed view].

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html

Examples:

Request syntax with placeholder values


resp = client.get_managed_view({
  managed_view_arn: "GetManagedViewInputManagedViewArnString", # required
})

Response structure


resp.managed_view.filters.filter_string #=> String
resp.managed_view.included_properties #=> Array
resp.managed_view.included_properties[0].name #=> String
resp.managed_view.last_updated_at #=> Time
resp.managed_view.managed_view_arn #=> String
resp.managed_view.managed_view_name #=> String
resp.managed_view.owner #=> String
resp.managed_view.resource_policy #=> String
resp.managed_view.scope #=> String
resp.managed_view.trusted_service #=> String
resp.managed_view.version #=> String

Options Hash (params):

  • :managed_view_arn (required, String) —

    The Amazon resource name (ARN) of the managed view.

See Also:



1015
1016
1017
1018
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1015

def get_managed_view(params = {}, options = {})
  req = build_request(:get_managed_view, params)
  req.send_request(options)
end

#get_view(params = {}) ⇒ Types::GetViewOutput

Retrieves details of the specified view.

Examples:

Request syntax with placeholder values


resp = client.get_view({
  view_arn: "GetViewInputViewArnString", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String
resp.view.filters.filter_string #=> String
resp.view.included_properties #=> Array
resp.view.included_properties[0].name #=> String
resp.view.last_updated_at #=> Time
resp.view.owner #=> String
resp.view.scope #=> String
resp.view.view_arn #=> String

Options Hash (params):

See Also:



1057
1058
1059
1060
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1057

def get_view(params = {}, options = {})
  req = build_request(:get_view, params)
  req.send_request(options)
end

#list_indexes(params = {}) ⇒ Types::ListIndexesOutput

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_indexes({
  max_results: 1,
  next_token: "ListIndexesInputNextTokenString",
  regions: ["String"],
  type: "LOCAL", # accepts LOCAL, AGGREGATOR
})

Response structure


resp.indexes #=> Array
resp.indexes[0].arn #=> String
resp.indexes[0].region #=> String
resp.indexes[0].type #=> String, one of "LOCAL", "AGGREGATOR"
resp.next_token #=> String

Options Hash (params):

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

  • :regions (Array<String>) —

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

  • :type (String) —

    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.

See Also:



1127
1128
1129
1130
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1127

def list_indexes(params = {}, options = {})
  req = build_request(:list_indexes, params)
  req.send_request(options)
end

#list_indexes_for_members(params = {}) ⇒ Types::ListIndexesForMembersOutput

Retrieves a list of a member’s indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_indexes_for_members({
  account_id_list: ["AccountId"], # required
  max_results: 1,
  next_token: "ListIndexesForMembersInputNextTokenString",
})

Response structure


resp.indexes #=> Array
resp.indexes[0]. #=> String
resp.indexes[0].arn #=> String
resp.indexes[0].region #=> String
resp.indexes[0].type #=> String, one of "LOCAL", "AGGREGATOR"
resp.next_token #=> String

Options Hash (params):

  • :account_id_list (required, Array<String>) —

    The account IDs will limit the output to only indexes from these accounts.

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

See Also:



1193
1194
1195
1196
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1193

def list_indexes_for_members(params = {}, options = {})
  req = build_request(:list_indexes_for_members, params)
  req.send_request(options)
end

#list_managed_views(params = {}) ⇒ Types::ListManagedViewsOutput

Lists the Amazon resource names (ARNs) of the [Amazon Web Services-managed views] available in the Amazon Web Services Region in which you call this operation.

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_views({
  max_results: 1,
  next_token: "ListManagedViewsInputNextTokenString",
  service_principal: "ListManagedViewsInputServicePrincipalString",
})

Response structure


resp.managed_views #=> Array
resp.managed_views[0] #=> String
resp.next_token #=> String

Options Hash (params):

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

  • :service_principal (String) —

    Specifies a service principal name. If specified, then the operation only returns the managed views that are managed by the input service.

See Also:



1258
1259
1260
1261
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1258

def list_managed_views(params = {}, options = {})
  req = build_request(:list_managed_views, params)
  req.send_request(options)
end

#list_resources(params = {}) ⇒ Types::ListResourcesOutput

Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resources({
  filters: {
    filter_string: "SearchFilterFilterStringString", # required
  },
  max_results: 1,
  next_token: "ListResourcesInputNextTokenString",
  view_arn: "ListResourcesInputViewArnString",
})

Response structure


resp.next_token #=> String
resp.resources #=> Array
resp.resources[0].arn #=> String
resp.resources[0].last_reported_at #=> Time
resp.resources[0]. #=> String
resp.resources[0].properties #=> Array
resp.resources[0].properties[0].last_reported_at #=> Time
resp.resources[0].properties[0].name #=> String
resp.resources[0].region #=> String
resp.resources[0].resource_type #=> String
resp.resources[0].service #=> String
resp.view_arn #=> String

Options Hash (params):

  • :filters (Types::SearchFilter) —

    A search filter defines which resources can be part of a search query result set.

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

  • :view_arn (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.

See Also:



1342
1343
1344
1345
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1342

def list_resources(params = {}, options = {})
  req = build_request(:list_resources, params)
  req.send_request(options)
end

#list_supported_resource_types(params = {}) ⇒ Types::ListSupportedResourceTypesOutput

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_supported_resource_types({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.resource_types #=> Array
resp.resource_types[0].resource_type #=> String
resp.resource_types[0].service #=> String

Options Hash (params):

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

See Also:



1398
1399
1400
1401
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1398

def list_supported_resource_types(params = {}, options = {})
  req = build_request(:list_supported_resource_types, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags that are attached to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (params):

See Also:



1432
1433
1434
1435
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1432

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_views(params = {}) ⇒ Types::ListViewsOutput

Lists the [Amazon resource names (ARNs)] of the views available in the Amazon Web Services Region in which you call this operation.

<note markdown=“1”> Always check the ‘NextToken` response parameter for a `null` value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The `NextToken` response parameter value is `null` only when there are no more results to display.

</note>

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_views({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.views #=> Array
resp.views[0] #=> String

Options Hash (params):

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

See Also:



1499
1500
1501
1502
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1499

def list_views(params = {}, options = {})
  req = build_request(:list_views, params)
  req.send_request(options)
end

#search(params = {}) ⇒ Types::SearchOutput

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

All search queries must use a view. If you don’t explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the ‘QueryString` parameter supplied to this operation and the `SearchFilter` parameter attached to the view.

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

If your search results are empty, or are missing results that you think should be there, see [Troubleshooting Resource Explorer search].

[1]: docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html [2]: docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search({
  max_results: 1,
  next_token: "SearchInputNextTokenString",
  query_string: "QueryString", # required
  view_arn: "SearchInputViewArnString",
})

Response structure


resp.count.complete #=> Boolean
resp.count.total_resources #=> Integer
resp.next_token #=> String
resp.resources #=> Array
resp.resources[0].arn #=> String
resp.resources[0].last_reported_at #=> Time
resp.resources[0]. #=> String
resp.resources[0].properties #=> Array
resp.resources[0].properties[0].last_reported_at #=> Time
resp.resources[0].properties[0].name #=> String
resp.resources[0].region #=> String
resp.resources[0].resource_type #=> String
resp.resources[0].service #=> String
resp.view_arn #=> String

Options Hash (params):

  • :max_results (Integer) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :next_token (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. The pagination tokens expire after 24 hours.

  • :query_string (required, 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.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html

  • :view_arn (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.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

See Also:



1621
1622
1623
1624
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1621

def search(params = {}, options = {})
  req = build_request(:search, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  tags: {
    "String" => "String",
  },
  resource_arn: "String", # required
})

Options Hash (params):

  • :tags (Hash<String,String>) —

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

  • :resource_arn (required, String) —

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

See Also:



1652
1653
1654
1655
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1652

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

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

See Also:



1681
1682
1683
1684
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1681

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_index_type(params = {}) ⇒ Types::UpdateIndexTypeOutput

Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see [Turning on cross-Region search by creating an aggregator index] in the *Amazon Web Services Resource Explorer User Guide*.

  • AGGREGATOR index type

    The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you’ve created a Resource Explorer index. Resource information from all other Regions is replicated to this Region’s index.

    When you change the index type to ‘AGGREGATOR`, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the `Status` response of that operation changes from `UPDATING` to `ACTIVE`. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.

    You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type ‘LOCAL`.

  • LOCAL index type

    The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.

    When you change the index type to ‘LOCAL`, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the `UPDATING` state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the `Status` response of that operation changes from `UPDATING` to `ACTIVE`. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.

    After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html

Examples:

Request syntax with placeholder values


resp = client.update_index_type({
  arn: "String", # required
  type: "LOCAL", # required, accepts LOCAL, AGGREGATOR
})

Response structure


resp.arn #=> String
resp.last_updated_at #=> Time
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
resp.type #=> String, one of "LOCAL", "AGGREGATOR"

Options Hash (params):

See Also:



1789
1790
1791
1792
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1789

def update_index_type(params = {}, options = {})
  req = build_request(:update_index_type, params)
  req.send_request(options)
end

#update_view(params = {}) ⇒ Types::UpdateViewOutput

Modifies some of the details of a view. You can change the filter string and the list of included properties. You can’t change the name of the view.

Examples:

Request syntax with placeholder values


resp = client.update_view({
  filters: {
    filter_string: "SearchFilterFilterStringString", # required
  },
  included_properties: [
    {
      name: "IncludedPropertyNameString", # required
    },
  ],
  view_arn: "UpdateViewInputViewArnString", # required
})

Response structure


resp.view.filters.filter_string #=> String
resp.view.included_properties #=> Array
resp.view.included_properties[0].name #=> String
resp.view.last_updated_at #=> Time
resp.view.owner #=> String
resp.view.scope #=> String
resp.view.view_arn #=> String

Options Hash (params):

See Also:



1869
1870
1871
1872
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1869

def update_view(params = {}, options = {})
  req = build_request(:update_view, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1898
1899
1900
 
# File 'lib/aws-sdk-resourceexplorer2/client.rb', line 1898

def waiter_names
  []
end