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

BatchGetView

Retrieves details about a list of views.

Minimum permissions

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

Action: resource-explorer-2:BatchGetView

Resource: No specific resource (*).

This action supports using condition keys to check the tags attached to the view to limit permissions.
Action: resource-explorer-2:GetView

Resource: the ARN of each view you want to retrieve.

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 update 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 for a Region, use DisassociateDefaultView.

Request Syntax


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

{
   "ViewArns": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ViewArns

A list of Amazon resource names (ARNs) that identify the views you want details for.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorMessage": "string",
         "ViewArn": "string"
      }
   ],
   "Views": [ 
      { 
         "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.

Errors

If any of the specified ARNs result in an error, then this structure describes the error.

Type: Array of BatchGetViewError objects

Views

A structure with a list of objects with details for each of the specified views.

Type: Array of View objects

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

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 returns details about two views, as specified by their ARNs.

Sample Request


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

{
    "ViewArns": [
        "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222",
        "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-Main-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>

{
    "Views": [
        {
            "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/My-EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222"
        },
        {
            "Filters": {
                "FilterString": ""
            },
            "IncludedProperties": [
                {
                    "Name":"tags"
                }
            ],
            "LastUpdatedAt":"2022-07-13T20:34:11.314Z",
            "Owner":"123456789012",
            "Scope":"arn:aws:iam::123456789012:root",
            "ViewArn":"arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-Main-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111"
        }
    ],
    "Errors": []
}