CreateAppInstanceAdmin
Promotes an AppInstanceUser or AppInstanceBot to an
AppInstanceAdmin. The
promoted entity can perform the following actions.
-
ChannelModeratoractions across all channels in theAppInstance. -
DeleteChannelMessageactions.
Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin
role.
Request Syntax
POST /app-instances/appInstanceArn/admins HTTP/1.1
Content-type: application/json
{
"AppInstanceAdminArn": "string"
}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
Request Body
The request accepts the following data in JSON format.
- AppInstanceAdminArn
-
The ARN of the administrator of the current
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}Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"AppInstanceAdmin": {
"Arn": "string",
"Name": "string"
},
"AppInstanceArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- AppInstanceAdmin
-
The ARN and name of the administrator, the ARN of the
AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.Type: Identity object
- AppInstanceArn
-
The ARN of the of the admin for 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}
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
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409
- 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:
