- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListLiveSourcesCommand
Lists the live sources contained in a source location. A source represents a piece of content.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaTailorClient, ListLiveSourcesCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, ListLiveSourcesCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // ListLiveSourcesRequest
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
SourceLocationName: "STRING_VALUE", // required
};
const command = new ListLiveSourcesCommand(input);
const response = await client.send(command);
// { // ListLiveSourcesResponse
// Items: [ // __listOfLiveSource
// { // LiveSource
// Arn: "STRING_VALUE", // required
// CreationTime: new Date("TIMESTAMP"),
// HttpPackageConfigurations: [ // HttpPackageConfigurations // required
// { // HttpPackageConfiguration
// Path: "STRING_VALUE", // required
// SourceGroup: "STRING_VALUE", // required
// Type: "DASH" || "HLS", // required
// },
// ],
// LastModifiedTime: new Date("TIMESTAMP"),
// LiveSourceName: "STRING_VALUE", // required
// SourceLocationName: "STRING_VALUE", // required
// Tags: { // __mapOf__string
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListLiveSourcesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
SourceLocationName Required | string | undefined | The name of the source location associated with this Live Sources list. |
MaxResults | number | undefined | The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than |
NextToken | string | undefined | Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. |
ListLiveSourcesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Items | LiveSource[] | undefined | Lists the live sources. |
NextToken | string | undefined | Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
MediaTailorServiceException | Base exception class for all service exceptions from MediaTailor service. |