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

ListMulticastGroups

Lists the multicast groups registered to your AWS account.

Request Syntax


GET /multicast-groups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in this operation.

Valid Range: Minimum value of 0. Maximum value of 250.

NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set 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

{
   "MulticastGroupList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "Name": "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.

MulticastGroupList

List of multicast groups.

Type: Array of MulticastGroup objects

NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set 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.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400