Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAttendees

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.

Request Syntax


GET /meetings/MeetingId/attendees?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

MeetingId

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

NextToken

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

Length Constraints: Maximum length of 4096.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Attendees": [ 
      { 
         "AttendeeId": "string",
         "Capabilities": { 
            "Audio": "string",
            "Content": "string",
            "Video": "string"
         },
         "ExternalUserId": "string",
         "JoinToken": "string"
      }
   ],
   "NextToken": "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.

Attendees

The Amazon Chime SDK attendee information.

Type: Array of Attendee objects

NextToken

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

Type: String

Length Constraints: Maximum length of 4096.

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.

RequestId: The request id associated with the call responsible for the exception.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

RequestId: The request id associated with the call responsible for the exception.

HTTP Status Code: 403

NotFoundException

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

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

RequestId: The ID of the failed request.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

RequestId: The request id associated with the call responsible for the exception.
RetryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

RequestId: The ID of the request that exceeded the throttling limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

RequestId: The request id associated with the call responsible for the exception.

HTTP Status Code: 401