ListProtectedQueries
Lists protected queries, sorted by the most recent query.
Request Syntax
GET /memberships/membershipIdentifier
/protectedQueries?maxResults=maxResults
&nextToken=nextToken
&status=status
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
Valid Range: Minimum value of 1. Maximum value of 100.
- membershipIdentifier
-
The identifier for the membership in the collaboration.
Length Constraints: Fixed length of 36.
Pattern:
.*[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}.*
Required: Yes
- nextToken
-
The token value retrieved from a previous call to access the next page of results.
Length Constraints: Minimum length of 0. Maximum length of 10240.
- status
-
A filter on the status of the protected query.
Valid Values:
SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"protectedQueries": [
{
"createTime": number,
"id": "string",
"membershipArn": "string",
"membershipId": "string",
"status": "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 token value retrieved from a previous call to access the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10240.
- protectedQueries
-
A list of protected queries.
Type: Array of ProtectedQuerySummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Caller does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: