com.amazonaws.services.resourceexplorer2

Interface AWSResourceExplorer2

All Known Subinterfaces:

AWSResourceExplorer2Async

All Known Implementing Classes:

AbstractAWSResourceExplorer2, AbstractAWSResourceExplorer2Async, AWSResourceExplorer2AsyncClient, AWSResourceExplorer2Client

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSResourceExplorer2

Interface for accessing AWS Resource Explorer.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSResourceExplorer2 instead.

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateDefaultViewResult	associateDefaultView(AssociateDefaultViewRequest associateDefaultViewRequest) Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.
BatchGetViewResult	batchGetView(BatchGetViewRequest batchGetViewRequest) Retrieves details about a list of views.
CreateIndexResult	createIndex(CreateIndexRequest createIndexRequest) Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.
CreateViewResult	createView(CreateViewRequest createViewRequest) Creates a view that users can query by using the Search operation.
DeleteIndexResult	deleteIndex(DeleteIndexRequest deleteIndexRequest) Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
DeleteViewResult	deleteView(DeleteViewRequest deleteViewRequest) Deletes the specified view.
DisassociateDefaultViewResult	disassociateDefaultView(DisassociateDefaultViewRequest disassociateDefaultViewRequest) After you call this operation, the affected Amazon Web Services Region no longer has a default view.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDefaultViewResult	getDefaultView(GetDefaultViewRequest getDefaultViewRequest) 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.
GetIndexResult	getIndex(GetIndexRequest getIndexRequest) Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
GetViewResult	getView(GetViewRequest getViewRequest) Retrieves details of the specified view.
ListIndexesResult	listIndexes(ListIndexesRequest listIndexesRequest) 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.
ListSupportedResourceTypesResult	listSupportedResourceTypes(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified resource.
ListViewsResult	listViews(ListViewsRequest listViewsRequest) Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
SearchResult	search(SearchRequest searchRequest) Searches for resources and displays details about all resources that match the specified criteria.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
UpdateIndexTypeResult	updateIndexType(UpdateIndexTypeRequest updateIndexTypeRequest) Changes the type of the index from one of the following types to the other.
UpdateViewResult	updateView(UpdateViewRequest updateViewRequest) Modifies some of the details of a view.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateDefaultView

AssociateDefaultViewResult associateDefaultView(AssociateDefaultViewRequest associateDefaultViewRequest)

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.

Parameters:

associateDefaultViewRequest -

Returns:

Result of the AssociateDefaultView operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

batchGetView

BatchGetViewResult batchGetView(BatchGetViewRequest batchGetViewRequest)

Retrieves details about a list of views.

Parameters:

batchGetViewRequest -

Returns:

Result of the BatchGetView operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

createIndex

CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

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

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

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

• Action: resource-explorer-2: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.

Parameters:

createIndexRequest -

Returns:

Result of the CreateIndex operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ConflictException - You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

createView

CreateViewResult createView(CreateViewRequest createViewRequest)

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.

Parameters:

createViewRequest -

Returns:

Result of the CreateView operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ConflictException - You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

ServiceQuotaExceededException - The request failed because it exceeds a service quota.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

deleteIndex

DeleteIndexResult deleteIndex(DeleteIndexRequest deleteIndexRequest)

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.

Parameters:

deleteIndexRequest -

Returns:

Result of the DeleteIndex operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

deleteView

DeleteViewResult deleteView(DeleteViewRequest deleteViewRequest)

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.

Parameters:

deleteViewRequest -

Returns:

Result of the DeleteView operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

disassociateDefaultView

DisassociateDefaultViewResult disassociateDefaultView(DisassociateDefaultViewRequest disassociateDefaultViewRequest)

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.

Parameters:

disassociateDefaultViewRequest -

Returns:

Result of the DisassociateDefaultView operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

getDefaultView

GetDefaultViewResult getDefaultView(GetDefaultViewRequest getDefaultViewRequest)

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.

Parameters:

getDefaultViewRequest -

Returns:

Result of the GetDefaultView operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

getIndex

GetIndexResult getIndex(GetIndexRequest getIndexRequest)

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

Parameters:

getIndexRequest -

Returns:

Result of the GetIndex operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

getView

GetViewResult getView(GetViewRequest getViewRequest)

Retrieves details of the specified view.

Parameters:

getViewRequest -

Returns:

Result of the GetView operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

listIndexes

ListIndexesResult listIndexes(ListIndexesRequest listIndexesRequest)

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.

Parameters:

listIndexesRequest -

Returns:

Result of the ListIndexes operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

listSupportedResourceTypes

ListSupportedResourceTypesResult listSupportedResourceTypes(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest)

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

Parameters:

listSupportedResourceTypesRequest -

Returns:

Result of the ListSupportedResourceTypes operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags that are attached to the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

listViews

ListViewsResult listViews(ListViewsRequest listViewsRequest)

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

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.

Parameters:

listViewsRequest -

Returns:

Result of the ListViews operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

search

SearchResult search(SearchRequest searchRequest)

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.

Parameters:

searchRequest -

Returns:

Result of the Search operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ConflictException - You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

updateIndexType

UpdateIndexTypeResult updateIndexType(UpdateIndexTypeRequest updateIndexTypeRequest)

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.

Parameters:

updateIndexTypeRequest -

Returns:

Result of the UpdateIndexType operation returned by the service.

Throws:

ResourceNotFoundException - You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ConflictException - You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

ServiceQuotaExceededException - The request failed because it exceeds a service quota.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

updateView

UpdateViewResult updateView(UpdateViewRequest updateViewRequest)

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.

Parameters:

updateViewRequest -

Returns:

Result of the UpdateView operation returned by the service.

Throws:

InternalServerException - The request failed because of internal service error. Try your request again later.

ValidationException - You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ServiceQuotaExceededException - The request failed because it exceeds a service quota.

UnauthorizedException - The principal making the request isn't permitted to perform the operation.

ThrottlingException - The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

AccessDeniedException - The credentials that you used to call this operation don't have the minimum required permissions.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.