AWS Resource Groups
Welcome (API Version 2017-11-27)

SearchResources

Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Request Syntax

POST /resources/search HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "ResourceQuery": { "Query": "string", "Type": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of group member ARNs returned by SearchResources in paginated output. By default, this number is 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The NextToken value that is returned in a paginated SearchResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

Type: String

Required: No

ResourceQuery

The search query, using the same formats that are supported for resource group definition.

Type: ResourceQuery object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ResourceIdentifiers": [ { "ResourceArn": "string", "ResourceType": "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.

NextToken

The NextToken value to include in a subsequent SearchResources request, to get more results.

Type: String

ResourceIdentifiers

The ARNs and resource types of resources that are members of the group that you specified.

Type: Array of ResourceIdentifier objects

Errors

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

BadRequestException

The request does not comply with validation rules that are defined for the request parameters.

HTTP Status Code: 400

ForbiddenException

The caller is not authorized to make the request.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method which is not allowed for the specified resource.

HTTP Status Code: 405

TooManyRequestsException

The caller has exceeded throttling limits.

HTTP Status Code: 429

UnauthorizedException

The request has not been applied because it lacks valid authentication credentials for the target resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: