Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

AssociateDefaultView

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

If an AWS Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.

Minimum permissions

To call this operation, you must have the following permissions:

Action: resource-explorer-2:AssociateDefaultView

Resource: No specific resource (*). However, an index must be present in the AWS Region in which you call the operation.

Related operations

To remove a view as the default for an AWS Region, use DisassociateDefaultView.
To list the available views, use ListViews.
To find which view is the default, use GetDefaultView.

Request Syntax


POST /AssociateDefaultView HTTP/1.1
Content-type: application/json

{
   "ViewArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ViewArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ViewArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ViewArn

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

Examples

Example

The following example sets the view named MyMainView, as specified by its ARN, to be the default for the AWS Region in which you call the operation, in this example, us-east-1.

Sample Request


POST /AssociateDefaultView HTTP/1.1
Host: resource-explorer-2.us-east-1.amazonaws.com
X-Amz-Date: 20221101T200059Z
Accept-Encoding: identity
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>

{
    "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyMainView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111"
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 01 Nov 2022 20:00:59 GMT
Content-Type: application/json
Content-Length: <PayloadSizeBytes>

{
    "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyMainView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111"
}