GetChannelGroup
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
Request Syntax
GET /channelGroup/ChannelGroupName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ChannelGroupName
-
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"ChannelGroupName": "string",
"CreatedAt": number,
"Description": "string",
"EgressDomain": "string",
"ETag": "string",
"ModifiedAt": number,
"tags": {
"string" : "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 Amazon Resource Name (ARN) associated with the resource.
Type: String
- ChannelGroupName
-
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Type: String
- CreatedAt
-
The date and time the channel group was created.
Type: Timestamp
- Description
-
The description for your channel group.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- EgressDomain
-
The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
Type: String
- ETag
-
The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S]+ - ModifiedAt
-
The date and time the channel group was modified.
Type: Timestamp
-
The comma-separated list of tag key:value pairs assigned to the channel group.
Type: String to string map
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403
- InternalServerException
-
Indicates that an error from the service occurred while trying to process a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
