ListVodSourcesCommand

Suggest an Edit

Lists the VOD 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, ListVodSourcesCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, ListVodSourcesCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // ListVodSourcesRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  SourceLocationName: "STRING_VALUE", // required
};
const command = new ListVodSourcesCommand(input);
const response = await client.send(command);
// { // ListVodSourcesResponse
//   Items: [ // __listOfVodSource
//     { // VodSource
//       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"),
//       SourceLocationName: "STRING_VALUE", // required
//       Tags: { // __mapOf__string
//         "<keys>": "STRING_VALUE",
//       },
//       VodSourceName: "STRING_VALUE", // required
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListVodSourcesCommand Input

See ListVodSourcesCommandInput for more details

Parameter
Type
Description
SourceLocationName
Required
string | undefined

The name of the source location associated with this VOD Source list.

MaxResults
number | undefined

The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

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.

ListVodSourcesCommand Output

See ListVodSourcesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Items
VodSource[] | undefined

Lists the VOD 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
MediaTailorServiceException
Base exception class for all service exceptions from MediaTailor service.