SearchApps
Searches for apps in an Amazon account using the specified filters. This operation is eventually consistent; the results might not reflect very recent updates. Results are paginated; use the NextToken parameter to retrieve additional results.
Request Syntax
POST /accounts/AwsAccountId/search/apps HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Value": "string"
}
],
"MaxResults": number,
"NextToken": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the Amazon account that contains the apps to search.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- Filters
-
The filters to apply to the search.
Type: Array of SearchAppsFilter objects
Required: Yes
- MaxResults
-
The maximum number of results to return in a single request. Valid range is 1 to 100. If you don't specify a value, the default is 20.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of results, or null if there are no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AppSummaryList": [
{
"AppId": "string",
"Arn": "string",
"CreatedTime": number,
"LastUpdatedTime": number,
"Name": "string",
"Visibility": "string"
}
],
"NextToken": "string",
"RequestId": "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.
- AppSummaryList
-
A list of app summaries that match the search criteria.
Type: Array of AppSummary objects
- NextToken
-
The token for the next set of results, or null if there are no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
- RequestId
-
The Amazon request ID for this operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 401
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 500
- InvalidParameterException
-
One or more parameter has a value that isn't valid.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 400
- ThrottlingException
-
Access is throttled.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: