@aws-sdk/client-elastic-transcoder-browser
Description
AWS Elastic Transcoder Service
The AWS Elastic Transcoder Service.
Installing
To install the this package using NPM, simply type the following into a terminal window:
npm install @aws-sdk/client-elastic-transcoder-browser
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(ElasticTranscoderClient
) and the commands you need, for example CancelJobCommand
:
//JavaScript
const {
ElasticTranscoderClient
} = require("@aws-sdk/client-elastic-transcoder-browser/ElasticTranscoderClient");
const {
CancelJobCommand
} = require("@aws-sdk/client-elastic-transcoder-browser/commands/CancelJobCommand");
//TypeScript
import { ElasticTranscoderClient } from "@aws-sdk/client-elastic-transcoder-browser/ElasticTranscoderClient";
import { CancelJobCommand } from "@aws-sdk/client-elastic-transcoder-browser/commands/CancelJobCommand";
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 elasticTranscoder = new ElasticTranscoderClient({region: 'region'});
//clients can be shared by different commands
const params = {
Id: /**a string value*/,
};
const cancelJobCommand = new CancelJobCommand(params);
elasticTranscoder.send(cancelJobCommand).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 elasticTranscoder.send(cancelJobCommand);
// do something
} catch (error) {
// error handling
}
// callback
elasticTranscoder.send(cancelJobCommand, (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-elastic-transcoder-browser/ElasticTranscoder";
const elasticTranscoder = new AWS.ElasticTranscoder({ region: "region" });
elasticTranscoder.cancelJob(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 elasticTranscoder.send(cancelJobCommand);
// 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-elastic-transcoder-browser' 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.