DescribeLiveSourceCommand

The live source to describe.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MediaTailorClient, DescribeLiveSourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, DescribeLiveSourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // DescribeLiveSourceRequest
  LiveSourceName: "STRING_VALUE", // required
  SourceLocationName: "STRING_VALUE", // required
};
const command = new DescribeLiveSourceCommand(input);
const response = await client.send(command);
// { // DescribeLiveSourceResponse
//   Arn: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   HttpPackageConfigurations: [ // HttpPackageConfigurations
//     { // HttpPackageConfiguration
//       Path: "STRING_VALUE", // required
//       SourceGroup: "STRING_VALUE", // required
//       Type: "DASH" || "HLS", // required
//     },
//   ],
//   LastModifiedTime: new Date("TIMESTAMP"),
//   LiveSourceName: "STRING_VALUE",
//   SourceLocationName: "STRING_VALUE",
//   Tags: { // __mapOf__string
//     "<keys>": "STRING_VALUE",
//   },
// };

DescribeLiveSourceCommand Input

See DescribeLiveSourceCommandInput for more details

Parameter
Type
Description
LiveSourceName
Required
string | undefined

The name of the live source.

SourceLocationName
Required
string | undefined

The name of the source location associated with this Live Source.

DescribeLiveSourceCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The ARN of the live source.

CreationTime
Date | undefined

The timestamp that indicates when the live source was created.

HttpPackageConfigurations
HttpPackageConfiguration[] | undefined

The HTTP package configurations.

LastModifiedTime
Date | undefined

The timestamp that indicates when the live source was modified.

LiveSourceName
string | undefined

The name of the live source.

SourceLocationName
string | undefined

The name of the source location associated with the live source.

Tags
Record<string, string> | undefined

The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

Throws

Name
Fault
Details
MediaTailorServiceException
Base exception class for all service exceptions from MediaTailor service.