Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ResourceExplorer2

import { ResourceExplorer2 } from "https://aws-api.deno.dev/v0.4/services/resourceexplorer2.ts?docs=full";
class ResourceExplorer2 {
constructor(apiFactory: client.ApiFactory);
async associateDefaultView(params: AssociateDefaultViewInput, opts?: client.RequestOptions): Promise<AssociateDefaultViewOutput>;
async batchGetView(params?: BatchGetViewInput, opts?: client.RequestOptions): Promise<BatchGetViewOutput>;
async createIndex(params?: CreateIndexInput, opts?: client.RequestOptions): Promise<CreateIndexOutput>;
async createView(params: CreateViewInput, opts?: client.RequestOptions): Promise<CreateViewOutput>;
async deleteIndex(params: DeleteIndexInput, opts?: client.RequestOptions): Promise<DeleteIndexOutput>;
async deleteView(params: DeleteViewInput, opts?: client.RequestOptions): Promise<DeleteViewOutput>;
async disassociateDefaultView(opts?: client.RequestOptions): Promise<void>;
async getDefaultView(opts?: client.RequestOptions): Promise<GetDefaultViewOutput>;
async getIndex(opts?: client.RequestOptions): Promise<GetIndexOutput>;
async getView(params: GetViewInput, opts?: client.RequestOptions): Promise<GetViewOutput>;
async listIndexes(params?: ListIndexesInput, opts?: client.RequestOptions): Promise<ListIndexesOutput>;
async listSupportedResourceTypes(params?: ListSupportedResourceTypesInput, opts?: client.RequestOptions): Promise<ListSupportedResourceTypesOutput>;
async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;
async listViews(params?: ListViewsInput, opts?: client.RequestOptions): Promise<ListViewsOutput>;
async search(params: SearchInput, opts?: client.RequestOptions): Promise<SearchOutput>;
async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;
async updateIndexType(params: UpdateIndexTypeInput, opts?: client.RequestOptions): Promise<UpdateIndexTypeOutput>;
async updateView(params: UpdateViewInput, opts?: client.RequestOptions): Promise<UpdateViewOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ResourceExplorer2(apiFactory: client.ApiFactory)
[src]

§Methods

§

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.

§
batchGetView(params?: BatchGetViewInput, opts?: client.RequestOptions): Promise<BatchGetViewOutput>
[src]

Retrieves details about a list of views.

§
createIndex(params?: CreateIndexInput, opts?: client.RequestOptions): Promise<CreateIndexOutput>
[src]

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: This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the "UpdateIndexType" operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.

  • Action: resource-explorer-2:CreateIndex Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account. "Resource": "arn:aws:resource-explorer-2:us-west-2::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.
§
createView(params: CreateViewInput, opts?: client.RequestOptions): Promise<CreateViewOutput>
[src]

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.

§
deleteIndex(params: DeleteIndexInput, opts?: client.RequestOptions): Promise<DeleteIndexOutput>
[src]

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

§
deleteView(params: DeleteViewInput, opts?: client.RequestOptions): Promise<DeleteViewOutput>
[src]

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.

§
disassociateDefaultView(opts?: client.RequestOptions): Promise<void>
[src]

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.

§
getDefaultView(opts?: client.RequestOptions): Promise<GetDefaultViewOutput>
[src]

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.

§
getIndex(opts?: client.RequestOptions): Promise<GetIndexOutput>
[src]

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

§
getView(params: GetViewInput, opts?: client.RequestOptions): Promise<GetViewOutput>
[src]

Retrieves details of the specified view.

§
listIndexes(params?: ListIndexesInput, opts?: client.RequestOptions): Promise<ListIndexesOutput>
[src]

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.

§

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

§

Lists the tags that are attached to the specified resource.

§
listViews(params?: ListViewsInput, opts?: client.RequestOptions): Promise<ListViewsOutput>
[src]

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

Note: 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.

§
tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updateIndexType(params: UpdateIndexTypeInput, opts?: client.RequestOptions): Promise<UpdateIndexTypeOutput>
[src]

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. ! IMPORTANT: ! 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. ! IMPORTANT: ! 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.
§
updateView(params: UpdateViewInput, opts?: client.RequestOptions): Promise<UpdateViewOutput>
[src]

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.

§Static Properties