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

GetMulticastGroup

Gets information about a multicast group.

Request Syntax


GET /multicast-groups/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the multicast group.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreatedAt": number,
   "Description": "string",
   "Id": "string",
   "LoRaWAN": { 
      "DlClass": "string",
      "NumberOfDevicesInGroup": number,
      "NumberOfDevicesRequested": number,
      "RfRegion": "string"
   },
   "Name": "string",
   "Status": "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.

Arn

The arn of the multicast group.

Type: String

Length Constraints: Maximum length of 128.

CreatedAt

Created at timestamp for the resource.

Type: Timestamp

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Id

The ID of the multicast group.

Type: String

Length Constraints: Maximum length of 256.

LoRaWAN

The LoRaWAN information that is to be returned from getting multicast group information.

Type: LoRaWANMulticastGet object

Name

The name of the multicast group.

Type: String

Length Constraints: Maximum length of 256.

Status

The status of the multicast group.

Type: String

Length Constraints: Maximum length of 256.

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

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

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