DescribeAppInstanceUserEndpoint
Returns the full details of an AppInstanceUserEndpoint.
Request Syntax
GET /app-instance-users/appInstanceUserArn/endpoints/endpointId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- appInstanceUserArn
-
The ARN of the
AppInstanceUser.Length Constraints: Minimum length of 0. Maximum length of 1600.
Pattern:
.*Required: Yes
- endpointId
-
The unique identifier of the
AppInstanceUserEndpoint.Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
.*Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AppInstanceUserEndpoint": {
"AllowMessages": "string",
"AppInstanceUserArn": "string",
"CreatedTimestamp": number,
"EndpointAttributes": {
"DeviceToken": "string",
"VoipDeviceToken": "string"
},
"EndpointId": "string",
"EndpointState": {
"Status": "string",
"StatusReason": "string"
},
"LastUpdatedTimestamp": number,
"Name": "string",
"ResourceArn": "string",
"Type": "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.
- AppInstanceUserEndpoint
-
The full details of an
AppInstanceUserEndpoint: theAppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.Type: AppInstanceUserEndpoint object
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
- 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:
