Skip to content

list_attendees 

list_attendees(
    meeting_id: GuidString,
    *,
    config_overrides: Optional[ChimeSDKMeetingsClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[ResultMax] = None,
) -> ListAttendeesResponse

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Parameters:

  • meeting_id (GuidString) –

    The Amazon Chime SDK meeting ID.

  • next_token (Optional[String], default: None ) –

    The token to use to retrieve the next page of results.

  • max_results (Optional[ResultMax], default: None ) –

    The maximum number of results to return in a single call.

Raises:

Source code in docs_src/capo_chime_sdk_meetings/_services/chime_sdk_meetings.py 
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
def list_attendees(
    self,
    meeting_id: "capo_chime_sdk_meetings.types.guid_string.GuidString",
    *,
    config_overrides: Optional[ChimeSDKMeetingsClientConfig] = None,
    next_token: Optional["capo_chime_sdk_meetings.types.string.String"] = None,
    max_results: Optional[
        "capo_chime_sdk_meetings.types.result_max.ResultMax"
    ] = None,
) -> "capo_chime_sdk_meetings.types.list_attendees_response.ListAttendeesResponse":
    """<p> Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>

    Args:
        meeting_id: <p>The Amazon Chime SDK meeting ID.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>

    Raises:
        capo_chime_sdk_meetings.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_meetings.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_meetings.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime_sdk_meetings.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_meetings.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_meetings.errors.throttling_exception.ThrottlingException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_meetings.errors.unauthorized_exception.UnauthorizedException: <p>The user isn't authorized to request a resource.</p>
        capo_chime_sdk_meetings.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_meetings.types.list_attendees_request.ListAttendeesRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_meetings.types.list_attendees_response.ListAttendeesResponse"
    ]:
        import capo_chime_sdk_meetings._operations.chime_meetings_sdk_service.list_attendees

        output, http_response = (
            capo_chime_sdk_meetings._operations.chime_meetings_sdk_service.list_attendees.list_attendees(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime_sdk_meetings.types.list_attendees_response.ListAttendeesResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_meetings.types.list_attendees_response

        return (
            capo_chime_sdk_meetings.types.list_attendees_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAttendees", redact_output=_redact_output),
    )
    input_: capo_chime_sdk_meetings.types.list_attendees_request.ListAttendeesRequest = {
        "meeting_id": meeting_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output