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

UpdateView

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.

Minimum permissions

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

Action: resource-explorer-2:UpdateView

Resource: The ARN of the specified view.

This action supports using condition keys to check the tags attached to the view to limit permissions.

Related operations

To create a view, use CreateView.
To list the views in an AWS Region, use ListViews.
To get details about your views, use GetView or BatchGetView.
To delete a view, use DeleteView.
To make a view the default for an AWS Region, use AssociateDefaultView. To remove the default for a Region, use DisassociateDefaultView.

Request Syntax


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

{
   "Filters": { 
      "FilterString": "string"
   },
   "IncludedProperties": [ 
      { 
         "Name": "string"
      }
   ],
   "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 that you want to modify.

Type: String

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

Required: Yes

Filters

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 AWS Resource Explorer User Guide.

Important

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

Type: SearchFilter object

Required: No

IncludedProperties

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.

Type: Array of IncludedProperty objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Filters": { 
         "FilterString": "string"
      },
      "IncludedProperties": [ 
         { 
            "Name": "string"
         }
      ],
      "LastUpdatedAt": "string",
      "Owner": "string",
      "Scope": "string",
      "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.

View

Details about the view that you changed with this operation.

Type: View object

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

ServiceQuotaExceededException

The request failed because it exceeds a service quota.

HTTP Status Code: 402

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

UnauthorizedException

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

HTTP Status Code: 401

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 1: Update the IncludedProperties field of a view

The following example updates the specified view by adding tags to its IncludedProperties field. After running this operation, search operations that use this view include information about any tags attached to the resources that appear in the results.

Sample Request


POST /UpdateView 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>

{
    "IncludedProperties": [
        {
            "Name": "tags"
        }
    ],
    "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222
}

Sample Response


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

{
    "View": {
        "Filters": {
            "FilterString": ""
        },
        "IncludedProperties": [
            {
                "Name":"tags"
            }
        ],
        "LastUpdatedAt": "2022-07-19T17:41:21.710Z",
        "Owner": "123456789012",
        "Scope": "arn:aws:iam::123456789012:root",
        "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222"
    }
}

Example 2: Update the filters attached to a view

The following example updates the specified view to use a filter that limits results to only resource types that are associated with the Amazon EC2 service.

Sample Request


POST /UpdateView 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>

{
    "Filters": {
        "FilterString": "service:ec2"
    },
    "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222
}

Sample Response


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

{
    "View": {
        "Filters": {
            "FilterString": "service:ec2"
        },
        "IncludedProperties": [],
        "LastUpdatedAt": "2022-07-19T17:41:21.710Z",
        "Owner": "123456789012",
        "Scope": "arn:aws:iam::123456789012:root",
        "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222"
    }
}