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

GetView

Retrieves details of the specified view.

Minimum permissions

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

Action: resource-explorer-2:GetView

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 get details about more than one view, use BatchGetView.
To create a view, use CreateView.
To list the views in an AWS Region, use ListViews.
To update the definition of a view, use UpdateView.
To delete a view, use DeleteView.
To make a view the default for an AWS Region, use AssociateDefaultView. To remove the default view for a Region, use DisassociateDefaultView.

Request Syntax


POST /GetView 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 that you want information about.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   },
   "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.

Tags

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

Type: String to string map

View

A structure that contains the details for the requested view.

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

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

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

The following example retrieves the details about the specified view. You can get the ARN of the view you want to inspect by calling the ListViews operation.

Sample Request


POST /GetView 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/EC2-Only-View/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>

{
  "Tags" : { },
  "View" : {
    "Filters" : {
      "FilterString" : "service:ec2"
    },
    "IncludedProperties" : [ {
      "Name" : "tags"
    } ],
    "LastUpdatedAt" : "2022-07-13T21:33:45.249Z",
    "Owner" : "123456789012",
    "Scope" : "arn:aws:iam::123456789012:root",
    "ViewArn" : "arn:aws:resource-explorer-2:us-east-1:123456789012:view/EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111"
  }
}