This package has been deprecated

    Author message:

    The package @aws-sdk/client-mediapackage-vod-node has been renamed to @aws-sdk/client-mediapackage-vod. Please install the renamed package.

    @aws-sdk/client-mediapackage-vod-node
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.0-preview.2 • Public • Published

    @aws-sdk/client-mediapackage-vod-node

    NPM version NPM downloads

    Description

    AWS Elemental MediaPackage VOD

    Installing

    To install the this package using NPM, simply type the following into a terminal window:

    npm install @aws-sdk/client-mediapackage-vod-node
    

    Getting Started

    Import

    The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(MediaPackageVodClient) and the commands you need, for example CreateAssetCommand:

    //JavaScript
    const {
      MediaPackageVodClient 
    = require("@aws-sdk/client-mediapackage-vod-node/MediaPackageVodClient");
    const {
      CreateAssetCommand 
    = require("@aws-sdk/client-mediapackage-vod-node/commands/CreateAssetCommand");
    //TypeScript
    import { MediaPackageVodClient } from "@aws-sdk/client-mediapackage-vod-node/MediaPackageVodClient";
    import { CreateAssetCommand } from "@aws-sdk/client-mediapackage-vod-node/commands/CreateAssetCommand";

    Usage

    To send a request, you:

    • Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
    • Initiate command with input parameters.
    • Call send operation on client with command object as input.
    • If you are using a custom http handler, you may call destroy() to close open connections.
    const mediaPackageVod = new MediaPackageVodClient({region: 'region'});
    //clients can be shared by different commands
    const params = {
      Id: /**a string value*/,
      PackagingGroupId: /**a string value*/,
      SourceArn: /**a string value*/,
      SourceRoleArn: /**a string value*/,
    };
    const createAssetCommand = new CreateAssetCommand(params);
    mediaPackageVod.send(createAssetCommand).then(data => {
        // do something
    }).catch(error => {
        // error handling
    })

    In addition to using promises, there are 2 other ways to send a request:

    // async/await
    try {
      const data = await mediaPackageVod.send(createAssetCommand);
      // do something
    } catch (error) {
      // error handling
    }
    // callback
    mediaPackageVod.send(createAssetCommand, (err, data) => {
      //do something
    });

    The SDK can also send requests using the simplified callback style from version 2 of the SDK.

    import * as AWS from "@aws-sdk/@aws-sdk/client-mediapackage-vod-node/MediaPackageVod";
    const mediaPackageVod = new AWS.MediaPackageVod({ region: "region" });
    mediaPackageVod.createAsset(params, (err, data) => {
      //do something
    });

    Troubleshooting

    When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

    try {
      const data = await mediaPackageVod.send(createAssetCommand);
      // do something
    } catch (error) {
      const metadata = error.$metadata;
      console.log(
        `requestId: ${metadata.requestId}
    cfId: ${metadata.cfId}
    extendedRequestId: ${metadata.extendedRequestId}`
      );
      /*
    The keys within exceptions are also parsed. You can access them by specifying exception names:
        if(error.name === 'SomeServiceException') {
            const value = error.specialKeyInException;
        }
    */
    }

    Getting Help

    Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

    • Ask a question on StackOverflow and tag it with aws-sdk-js
    • Come join the AWS JavaScript community on gitter
    • If it turns out that you may have found a bug, please open an issue

    Contributing

    This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-mediapackage-vod-node' package is updated. To contribute to SDK you can checkout our code generator package.

    License

    This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

    Keywords

    none

    Install

    npm i @aws-sdk/client-mediapackage-vod-node

    DownloadsWeekly Downloads

    3

    Version

    0.1.0-preview.2

    License

    Apache-2.0

    Unpacked Size

    271 kB

    Total Files

    440

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar