create_room_membership `async` ¶

create_room_membership(
    account_id: NonEmptyString,
    room_id: NonEmptyString,
    member_id: NonEmptyString,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
    role: Optional[RoomMembershipRole] = None,
) -> CreateRoomMembershipResponse

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

Parameters:

account_id (NonEmptyString) –

The Amazon Chime account ID.
room_id (NonEmptyString) –

The room ID.
member_id (NonEmptyString) –

The Amazon Chime member ID (user ID or bot ID).
role (Optional[RoomMembershipRole], default: None ) –

The role of the member.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ConflictException –

The request could not be processed because of conflict in the current state of the resource.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

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

The request exceeds the resource limit.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_chime/_services/async_chime.py

async def create_room_membership(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    room_id: "capo_chime.types.non_empty_string.NonEmptyString",
    member_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
    role: Optional[
        "capo_chime.types.room_membership_role.RoomMembershipRole"
    ] = None,
) -> (
    "capo_chime.types.create_room_membership_response.CreateRoomMembershipResponse"
):
    """<p>Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        room_id: <p>The room ID.</p>
        member_id: <p>The Amazon Chime member ID (user ID or bot ID).</p>
        role: <p>The role of the member.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.create_room_membership_request.CreateRoomMembershipRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.create_room_membership_response.CreateRoomMembershipResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.create_room_membership

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.create_room_membership.async_create_room_membership(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime.types.create_room_membership_response.CreateRoomMembershipResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.create_room_membership_response

        return capo_chime.types.create_room_membership_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateRoomMembership", redact_output=_redact_output),
    )
    input_: capo_chime.types.create_room_membership_request.CreateRoomMembershipRequest = {
        "account_id": account_id,
        "room_id": room_id,
        "member_id": member_id,
    }
    if role is not None:
        input_["role"] = role

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_room_membership async ¶

create_room_membership `async` ¶