ListAppInstanceAdmins
Returns a list of the administrators in the AppInstance.
Request Syntax
GET /app-instances/appInstanceArn/admins?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- appInstanceArn
-
The ARN of the
AppInstance.Length Constraints: Minimum length of 5. Maximum length of 1600.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: Yes
- MaxResults
-
The maximum number of administrators that you want to return.
Valid Range: Minimum value of 1. Maximum value of 50.
- NextToken
-
The token returned from previous API requests until the number of administrators is reached.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AppInstanceAdmins": [
{
"Admin": {
"Arn": "string",
"Name": "string"
}
}
],
"AppInstanceArn": "string",
"NextToken": "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.
- AppInstanceAdmins
-
The information for each administrator.
Type: Array of AppInstanceAdminSummary objects
- AppInstanceArn
-
The ARN of the
AppInstance.Type: String
Length Constraints: Minimum length of 5. Maximum length of 1600.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} - NextToken
-
The token returned from previous API requests until the number of administrators is reached.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- ResourceLimitExceededException
-
The request exceeds the resource limit.
HTTP Status Code: 400
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
