UpdateRoomMembership - Amazon Chime

UpdateRoomMembership

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Request Syntax

POST /accounts/accountId/rooms/roomId/memberships/memberId HTTP/1.1 Content-type: application/json { "Role": "string" }

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

memberId

The member ID.

Pattern: .*\S.*

Required: Yes

roomId

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Role

The role of the member.

Type: String

Valid Values: Administrator | Member

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "RoomMembership": { "InvitedBy": "string", "Member": { "AccountId": "string", "Email": "string", "FullName": "string", "MemberId": "string", "MemberType": "string" }, "Role": "string", "RoomId": "string", "UpdatedTimestamp": number } }

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.

RoomMembership

The room membership details.

Type: RoomMembership 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. For example, when a user tries to create an account from an unsupported Region.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

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

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example updates the specified chat room member role to administrator.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships/1ab2345c-67de-8901-f23g-45h678901j2k HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T224022Z Authorization: AUTHPARAMS Content-Length: 25 {"Role": "Administrator"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: afe39bf2-b34c-40d3-8b0d-fd402971bc1c Content-Type: application/json Content-Length: 388 Date: Mon, 02 Dec 2019 22:40:22 GMT Connection: keep-alive {"RoomMembership":{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"janed@example.com","FullName":"Jane Doe","MemberId":"1ab2345c-67de-8901-f23g-45h678901j2k","MemberType":"User"},"Role":"Administrator","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:40:22.931Z"}}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: