ListOriginEndpoints
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
Request Syntax
GET /channelGroup/ChannelGroupName
/channel/ChannelName
/originEndpoint?maxResults=MaxResults
&nextToken=NextToken
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
- ChannelName
-
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+
Required: Yes
- MaxResults
-
The maximum number of results to return in the response.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The pagination token from the GET list request. Use the token to fetch the next page of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Items": [
{
"Arn": "string",
"ChannelGroupName": "string",
"ChannelName": "string",
"ContainerType": "string",
"CreatedAt": number,
"DashManifests": [
{
"ManifestName": "string",
"Url": "string"
}
],
"Description": "string",
"ForceEndpointErrorConfiguration": {
"EndpointErrorConditions": [ "string" ]
},
"HlsManifests": [
{
"ChildManifestName": "string",
"ManifestName": "string",
"Url": "string"
}
],
"LowLatencyHlsManifests": [
{
"ChildManifestName": "string",
"ManifestName": "string",
"Url": "string"
}
],
"ModifiedAt": number,
"OriginEndpointName": "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.
- Items
-
The objects being returned.
Type: Array of OriginEndpointListConfiguration objects
- NextToken
-
The pagination token from the GET list request. Use the token to fetch the next page of results.
Type: String
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: