- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MediaPackageClient
AWS Elemental MediaPackage
Installation
NPM
npm install @aws-sdk/client-mediapackage
Yarn
yarn add @aws-sdk/client-mediapackage
pnpm
pnpm add @aws-sdk/client-mediapackage
MediaPackageClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
ConfigureLogsCommand | Changes the Channel's properities to configure log subscription |
CreateChannelCommand | Creates a new Channel. |
CreateHarvestJobCommand | Creates a new HarvestJob record. |
CreateOriginEndpointCommand | Creates a new OriginEndpoint record. |
DeleteChannelCommand | Deletes an existing Channel. |
DeleteOriginEndpointCommand | Deletes an existing OriginEndpoint. |
DescribeChannelCommand | Gets details about a Channel. |
DescribeHarvestJobCommand | Gets details about an existing HarvestJob. |
DescribeOriginEndpointCommand | Gets details about an existing OriginEndpoint. |
ListChannelsCommand | Returns a collection of Channels. |
ListHarvestJobsCommand | Returns a collection of HarvestJob records. |
ListOriginEndpointsCommand | Returns a collection of OriginEndpoint records. |
ListTagsForResourceCommand | |
RotateChannelCredentialsCommand | Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead |
RotateIngestEndpointCredentialsCommand | Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. |
TagResourceCommand | |
UntagResourceCommand | |
UpdateChannelCommand | Updates an existing Channel. |
UpdateOriginEndpointCommand | Updates an existing OriginEndpoint. |
MediaPackageClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MediaPackageClientConfig