GetChannelMembershipPreferences
Gets the membership preferences of an AppInstanceUser
for the specified channel. The AppInstanceUser
must be a member of the channel.
Only the AppInstanceUser
who owns the membership can retrieve preferences. Users in the AppInstanceAdmin
and channel moderator roles can't retrieve preferences for other users.
Banned users can't retrieve membership preferences for the channel from which they are banned.
Request Syntax
GET /channels/channelArn
/memberships/memberArn
/preferences HTTP/1.1
x-amz-chime-bearer: ChimeBearer
URI Request Parameters
The request uses the following URI parameters.
- channelArn
-
The ARN of the channel.
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
- ChimeBearer
-
The
AppInstanceUserARN
of the user making the API call.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
- memberArn
-
The
AppInstanceUserArn
of the member retrieving the preferences.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 does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
},
"Preferences": {
"PushNotifications": {
"AllowNotifications": "string",
"FilterRule": "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.
- ChannelArn
-
The ARN of the channel.
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}
- Member
-
The details of a user.
Type: Identity object
- Preferences
-
The channel membership preferences for an
AppInstanceUser
.Type: ChannelMembershipPreferences 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: