pub struct Client { /* private fields */ }
Expand description
Client for AWS Elemental MediaPackage v2
Client for invoking operations on AWS Elemental MediaPackage v2. Each operation on AWS Elemental MediaPackage v2 is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_mediapackagev2::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_mediapackagev2::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CancelHarvestJob
operation has
a Client::cancel_harvest_job
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.cancel_harvest_job()
.channel_group_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn cancel_harvest_job(&self) -> CancelHarvestJobFluentBuilder
pub fn cancel_harvest_job(&self) -> CancelHarvestJobFluentBuilder
Constructs a fluent builder for the CancelHarvestJob
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group containing the channel from which the harvest job is running.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name of the channel from which the harvest job is running.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.
harvest_job_name(impl Into<String>)
/set_harvest_job_name(Option<String>)
:
required: trueThe name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.
e_tag(impl Into<String>)
/set_e_tag(Option<String>)
:
required: falseThe current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.
- On success, responds with
CancelHarvestJobOutput
- On failure, responds with
SdkError<CancelHarvestJobError>
Source§impl Client
impl Client
Sourcepub fn create_channel(&self) -> CreateChannelFluentBuilder
pub fn create_channel(&self) -> CreateChannelFluentBuilder
Constructs a fluent builder for the CreateChannel
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can’t change the name after you create the channel.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive token that you provide to ensure the idempotency of the request.
input_type(InputType)
/set_input_type(Option<InputType>)
:
required: falseThe input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS
- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF
- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
-
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseEnter any descriptive text that helps you to identify the channel.
input_switch_configuration(InputSwitchConfiguration)
/set_input_switch_configuration(Option<InputSwitchConfiguration>)
:
required: falseThe configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when
InputType
isCMAF
.output_header_configuration(OutputHeaderConfiguration)
/set_output_header_configuration(Option<OutputHeaderConfiguration>)
:
required: falseThe settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when
InputType
isCMAF
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA comma-separated list of tag key:value pairs that you define. For example:
“Key1”: “Value1”,
“Key2”: “Value2”
- On success, responds with
CreateChannelOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
created_at(DateTime)
:The date and time the channel was created.
modified_at(DateTime)
:The date and time the channel was modified.
description(Option<String>)
:The description for your channel.
ingest_endpoints(Option<Vec::<IngestEndpoint>>)
:The list of ingest endpoints.
input_type(Option<InputType>)
:The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS
- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF
- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
-
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel.
input_switch_configuration(Option<InputSwitchConfiguration>)
:The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when
InputType
isCMAF
.output_header_configuration(Option<OutputHeaderConfiguration>)
:The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when
InputType
isCMAF
.
- On failure, responds with
SdkError<CreateChannelError>
Source§impl Client
impl Client
Sourcepub fn create_channel_group(&self) -> CreateChannelGroupFluentBuilder
pub fn create_channel_group(&self) -> CreateChannelGroupFluentBuilder
Constructs a fluent builder for the CreateChannelGroup
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can’t use spaces in the name. You can’t change the name after you create the channel group.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive token that you provide to ensure the idempotency of the request.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseEnter any descriptive text that helps you to identify the channel group.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA comma-separated list of tag key:value pairs that you define. For example:
“Key1”: “Value1”,
“Key2”: “Value2”
- On success, responds with
CreateChannelGroupOutput
with field(s):channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
egress_domain(String)
:The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.
created_at(DateTime)
:The date and time the channel group was created.
modified_at(DateTime)
:The date and time the channel group was modified.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
description(Option<String>)
:The description for your channel group.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel group.
- On failure, responds with
SdkError<CreateChannelGroupError>
Source§impl Client
impl Client
Sourcepub fn create_harvest_job(&self) -> CreateHarvestJobFluentBuilder
pub fn create_harvest_job(&self) -> CreateHarvestJobFluentBuilder
Constructs a fluent builder for the CreateHarvestJob
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group containing the channel from which to harvest content.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name of the channel from which to harvest content.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name of the origin endpoint from which to harvest content.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAn optional description for the harvest job.
harvested_manifests(HarvestedManifests)
/set_harvested_manifests(Option<HarvestedManifests>)
:
required: trueA list of manifests to be harvested.
schedule_configuration(HarvesterScheduleConfiguration)
/set_schedule_configuration(Option<HarvesterScheduleConfiguration>)
:
required: trueThe configuration for when the harvest job should run, including start and end times.
destination(Destination)
/set_destination(Option<Destination>)
:
required: trueThe S3 destination where the harvested content will be placed.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
harvest_job_name(impl Into<String>)
/set_harvest_job_name(Option<String>)
:
required: falseA name for the harvest job. This name must be unique within the channel.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA collection of tags associated with the harvest job.
- On success, responds with
CreateHarvestJobOutput
with field(s):channel_group_name(String)
:The name of the channel group containing the channel from which content is being harvested.
channel_name(String)
:The name of the channel from which content is being harvested.
origin_endpoint_name(String)
:The name of the origin endpoint from which content is being harvested.
destination(Option<Destination>)
:The S3 destination where the harvested content will be placed.
harvest_job_name(String)
:The name of the created harvest job.
harvested_manifests(Option<HarvestedManifests>)
:A list of manifests that will be harvested.
description(Option<String>)
:The description of the harvest job, if provided.
schedule_configuration(Option<HarvesterScheduleConfiguration>)
:The configuration for when the harvest job will run, including start and end times.
arn(String)
:The Amazon Resource Name (ARN) of the created harvest job.
created_at(DateTime)
:The date and time the harvest job was created.
modified_at(DateTime)
:The date and time the harvest job was last modified.
status(HarvestJobStatus)
:The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).
error_message(Option<String>)
:An error message if the harvest job creation failed.
e_tag(Option<String>)
:The current version of the harvest job. Used for concurrency control.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the harvest job.
- On failure, responds with
SdkError<CreateHarvestJobError>
Source§impl Client
impl Client
Sourcepub fn create_origin_endpoint(&self) -> CreateOriginEndpointFluentBuilder
pub fn create_origin_endpoint(&self) -> CreateOriginEndpointFluentBuilder
Constructs a fluent builder for the CreateOriginEndpoint
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can’t use spaces in the name. You can’t change the name after you create the endpoint.
container_type(ContainerType)
/set_container_type(Option<ContainerType>)
:
required: trueThe type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can’t change the container type after you create the endpoint.
segment(Segment)
/set_segment(Option<Segment>)
:
required: falseThe segment configuration, including the segment name, duration, and other configuration values.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive token that you provide to ensure the idempotency of the request.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseEnter any descriptive text that helps you to identify the origin endpoint.
startover_window_seconds(i32)
/set_startover_window_seconds(Option<i32>)
:
required: falseThe size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
hls_manifests(CreateHlsManifestConfiguration)
/set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>)
:
required: falseAn HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration)
/set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>)
:
required: falseA low-latency HLS manifest configuration.
dash_manifests(CreateDashManifestConfiguration)
/set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>)
:
required: falseA DASH manifest configuration.
force_endpoint_error_configuration(ForceEndpointErrorConfiguration)
/set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)
:
required: falseThe failover settings for the endpoint.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA comma-separated list of tag key:value pairs that you define. For example:
“Key1”: “Value1”,
“Key2”: “Value2”
- On success, responds with
CreateOriginEndpointOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(String)
:The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
container_type(ContainerType)
:The type of container attached to this origin endpoint.
segment(Option<Segment>)
:The segment configuration, including the segment name, duration, and other configuration values.
created_at(DateTime)
:The date and time the origin endpoint was created.
modified_at(DateTime)
:The date and time the origin endpoint was modified.
description(Option<String>)
:The description for your origin endpoint.
startover_window_seconds(Option<i32>)
:The size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)
:An HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)
:A low-latency HLS manifest configuration.
dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)
:A DASH manifest configuration.
force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)
:The failover settings for the endpoint.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the origin endpoint.
- On failure, responds with
SdkError<CreateOriginEndpointError>
Source§impl Client
impl Client
Sourcepub fn delete_channel(&self) -> DeleteChannelFluentBuilder
pub fn delete_channel(&self) -> DeleteChannelFluentBuilder
Constructs a fluent builder for the DeleteChannel
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
- On success, responds with
DeleteChannelOutput
- On failure, responds with
SdkError<DeleteChannelError>
Source§impl Client
impl Client
Sourcepub fn delete_channel_group(&self) -> DeleteChannelGroupFluentBuilder
pub fn delete_channel_group(&self) -> DeleteChannelGroupFluentBuilder
Constructs a fluent builder for the DeleteChannelGroup
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
- On success, responds with
DeleteChannelGroupOutput
- On failure, responds with
SdkError<DeleteChannelGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_channel_policy(&self) -> DeleteChannelPolicyFluentBuilder
pub fn delete_channel_policy(&self) -> DeleteChannelPolicyFluentBuilder
Constructs a fluent builder for the DeleteChannelPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
- On success, responds with
DeleteChannelPolicyOutput
- On failure, responds with
SdkError<DeleteChannelPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_origin_endpoint(&self) -> DeleteOriginEndpointFluentBuilder
pub fn delete_origin_endpoint(&self) -> DeleteOriginEndpointFluentBuilder
Constructs a fluent builder for the DeleteOriginEndpoint
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
- On success, responds with
DeleteOriginEndpointOutput
- On failure, responds with
SdkError<DeleteOriginEndpointError>
Source§impl Client
impl Client
Sourcepub fn delete_origin_endpoint_policy(
&self,
) -> DeleteOriginEndpointPolicyFluentBuilder
pub fn delete_origin_endpoint_policy( &self, ) -> DeleteOriginEndpointPolicyFluentBuilder
Constructs a fluent builder for the DeleteOriginEndpointPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
- On success, responds with
DeleteOriginEndpointPolicyOutput
- On failure, responds with
SdkError<DeleteOriginEndpointPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_channel(&self) -> GetChannelFluentBuilder
pub fn get_channel(&self) -> GetChannelFluentBuilder
Constructs a fluent builder for the GetChannel
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
- On success, responds with
GetChannelOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
created_at(DateTime)
:The date and time the channel was created.
modified_at(DateTime)
:The date and time the channel was modified.
reset_at(Option<DateTime>)
:The time that the channel was last reset.
description(Option<String>)
:The description for your channel.
ingest_endpoints(Option<Vec::<IngestEndpoint>>)
:The list of ingest endpoints.
input_type(Option<InputType>)
:The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS
- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF
- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
-
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel.
input_switch_configuration(Option<InputSwitchConfiguration>)
:The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when
InputType
isCMAF
.output_header_configuration(Option<OutputHeaderConfiguration>)
:The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when
InputType
isCMAF
.
- On failure, responds with
SdkError<GetChannelError>
Source§impl Client
impl Client
Sourcepub fn get_channel_group(&self) -> GetChannelGroupFluentBuilder
pub fn get_channel_group(&self) -> GetChannelGroupFluentBuilder
Constructs a fluent builder for the GetChannelGroup
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
- On success, responds with
GetChannelGroupOutput
with field(s):channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
egress_domain(String)
:The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
created_at(DateTime)
:The date and time the channel group was created.
modified_at(DateTime)
:The date and time the channel group was modified.
description(Option<String>)
:The description for your channel group.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel group.
- On failure, responds with
SdkError<GetChannelGroupError>
Source§impl Client
impl Client
Sourcepub fn get_channel_policy(&self) -> GetChannelPolicyFluentBuilder
pub fn get_channel_policy(&self) -> GetChannelPolicyFluentBuilder
Constructs a fluent builder for the GetChannelPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
- On success, responds with
GetChannelPolicyOutput
with field(s):channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
policy(String)
:The policy assigned to the channel.
- On failure, responds with
SdkError<GetChannelPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_harvest_job(&self) -> GetHarvestJobFluentBuilder
pub fn get_harvest_job(&self) -> GetHarvestJobFluentBuilder
Constructs a fluent builder for the GetHarvestJob
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group containing the channel associated with the harvest job.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name of the channel associated with the harvest job.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name of the origin endpoint associated with the harvest job.
harvest_job_name(impl Into<String>)
/set_harvest_job_name(Option<String>)
:
required: trueThe name of the harvest job to retrieve.
- On success, responds with
GetHarvestJobOutput
with field(s):channel_group_name(String)
:The name of the channel group containing the channel associated with the harvest job.
channel_name(String)
:The name of the channel associated with the harvest job.
origin_endpoint_name(String)
:The name of the origin endpoint associated with the harvest job.
destination(Option<Destination>)
:The S3 destination where the harvested content is being placed.
harvest_job_name(String)
:The name of the harvest job.
harvested_manifests(Option<HarvestedManifests>)
:A list of manifests that are being or have been harvested.
description(Option<String>)
:The description of the harvest job, if provided.
schedule_configuration(Option<HarvesterScheduleConfiguration>)
:The configuration for when the harvest job is scheduled to run, including start and end times.
arn(String)
:The Amazon Resource Name (ARN) of the harvest job.
created_at(DateTime)
:The date and time when the harvest job was created.
modified_at(DateTime)
:The date and time when the harvest job was last modified.
status(HarvestJobStatus)
:The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
error_message(Option<String>)
:An error message if the harvest job encountered any issues.
e_tag(Option<String>)
:The current version of the harvest job. Used for concurrency control.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the harvest job.
- On failure, responds with
SdkError<GetHarvestJobError>
Source§impl Client
impl Client
Sourcepub fn get_origin_endpoint(&self) -> GetOriginEndpointFluentBuilder
pub fn get_origin_endpoint(&self) -> GetOriginEndpointFluentBuilder
Constructs a fluent builder for the GetOriginEndpoint
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
- On success, responds with
GetOriginEndpointOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(String)
:The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
container_type(ContainerType)
:The type of container attached to this origin endpoint.
segment(Option<Segment>)
:The segment configuration, including the segment name, duration, and other configuration values.
created_at(DateTime)
:The date and time the origin endpoint was created.
modified_at(DateTime)
:The date and time the origin endpoint was modified.
reset_at(Option<DateTime>)
:The time that the origin endpoint was last reset.
description(Option<String>)
:The description for your origin endpoint.
startover_window_seconds(Option<i32>)
:The size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)
:An HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)
:A low-latency HLS manifest configuration.
dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)
:A DASH manifest configuration.
force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)
:The failover settings for the endpoint.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the origin endpoint.
- On failure, responds with
SdkError<GetOriginEndpointError>
Source§impl Client
impl Client
Sourcepub fn get_origin_endpoint_policy(&self) -> GetOriginEndpointPolicyFluentBuilder
pub fn get_origin_endpoint_policy(&self) -> GetOriginEndpointPolicyFluentBuilder
Constructs a fluent builder for the GetOriginEndpointPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
- On success, responds with
GetOriginEndpointPolicyOutput
with field(s):channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(String)
:The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
policy(String)
:The policy assigned to the origin endpoint.
- On failure, responds with
SdkError<GetOriginEndpointPolicyError>
Source§impl Client
impl Client
Sourcepub fn list_channel_groups(&self) -> ListChannelGroupsFluentBuilder
pub fn list_channel_groups(&self) -> ListChannelGroupsFluentBuilder
Constructs a fluent builder for the ListChannelGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token from the GET list request. Use the token to fetch the next page of results.
- On success, responds with
ListChannelGroupsOutput
with field(s):items(Option<Vec::<ChannelGroupListConfiguration>>)
:The objects being returned.
next_token(Option<String>)
:The pagination token from the GET list request. Use the token to fetch the next page of results.
- On failure, responds with
SdkError<ListChannelGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_channels(&self) -> ListChannelsFluentBuilder
pub fn list_channels(&self) -> ListChannelsFluentBuilder
Constructs a fluent builder for the ListChannels
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token from the GET list request. Use the token to fetch the next page of results.
- On success, responds with
ListChannelsOutput
with field(s):items(Option<Vec::<ChannelListConfiguration>>)
:The objects being returned.
next_token(Option<String>)
:The pagination token from the GET list request.
- On failure, responds with
SdkError<ListChannelsError>
Source§impl Client
impl Client
Sourcepub fn list_harvest_jobs(&self) -> ListHarvestJobsFluentBuilder
pub fn list_harvest_jobs(&self) -> ListHarvestJobsFluentBuilder
Constructs a fluent builder for the ListHarvestJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: falseThe name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: falseThe name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.
status(HarvestJobStatus)
/set_status(Option<HarvestJobStatus>)
:
required: falseThe status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.
- On success, responds with
ListHarvestJobsOutput
with field(s):items(Option<Vec::<HarvestJob>>)
:An array of harvest job objects that match the specified criteria.
next_token(Option<String>)
:A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.
- On failure, responds with
SdkError<ListHarvestJobsError>
Source§impl Client
impl Client
Sourcepub fn list_origin_endpoints(&self) -> ListOriginEndpointsFluentBuilder
pub fn list_origin_endpoints(&self) -> ListOriginEndpointsFluentBuilder
Constructs a fluent builder for the ListOriginEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token from the GET list request. Use the token to fetch the next page of results.
- On success, responds with
ListOriginEndpointsOutput
with field(s):items(Option<Vec::<OriginEndpointListConfiguration>>)
:The objects being returned.
next_token(Option<String>)
:The pagination token from the GET list request. Use the token to fetch the next page of results.
- On failure, responds with
SdkError<ListOriginEndpointsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the CloudWatch resource that you want to view tags for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn put_channel_policy(&self) -> PutChannelPolicyFluentBuilder
pub fn put_channel_policy(&self) -> PutChannelPolicyFluentBuilder
Constructs a fluent builder for the PutChannelPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe policy to attach to the specified channel.
- On success, responds with
PutChannelPolicyOutput
- On failure, responds with
SdkError<PutChannelPolicyError>
Source§impl Client
impl Client
Sourcepub fn put_origin_endpoint_policy(&self) -> PutOriginEndpointPolicyFluentBuilder
pub fn put_origin_endpoint_policy(&self) -> PutOriginEndpointPolicyFluentBuilder
Constructs a fluent builder for the PutOriginEndpointPolicy
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe policy to attach to the specified origin endpoint.
- On success, responds with
PutOriginEndpointPolicyOutput
- On failure, responds with
SdkError<PutOriginEndpointPolicyError>
Source§impl Client
impl Client
Sourcepub fn reset_channel_state(&self) -> ResetChannelStateFluentBuilder
pub fn reset_channel_state(&self) -> ResetChannelStateFluentBuilder
Constructs a fluent builder for the ResetChannelState
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group that contains the channel that you are resetting.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name of the channel that you are resetting.
- On success, responds with
ResetChannelStateOutput
with field(s):channel_group_name(String)
:The name of the channel group that contains the channel that you just reset.
channel_name(String)
:The name of the channel that you just reset.
arn(String)
:The Amazon Resource Name (ARN) associated with the channel that you just reset.
reset_at(DateTime)
:The time that the channel was last reset.
- On failure, responds with
SdkError<ResetChannelStateError>
Source§impl Client
impl Client
Sourcepub fn reset_origin_endpoint_state(
&self,
) -> ResetOriginEndpointStateFluentBuilder
pub fn reset_origin_endpoint_state( &self, ) -> ResetOriginEndpointStateFluentBuilder
Constructs a fluent builder for the ResetOriginEndpointState
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name of the channel group that contains the channel with the origin endpoint that you are resetting.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name of the channel with the origin endpoint that you are resetting.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name of the origin endpoint that you are resetting.
- On success, responds with
ResetOriginEndpointStateOutput
with field(s):channel_group_name(String)
:The name of the channel group that contains the channel with the origin endpoint that you just reset.
channel_name(String)
:The name of the channel with the origin endpoint that you just reset.
origin_endpoint_name(String)
:The name of the origin endpoint that you just reset.
arn(String)
:The Amazon Resource Name (ARN) associated with the endpoint that you just reset.
reset_at(DateTime)
:The time that the origin endpoint was last reset.
- On failure, responds with
SdkError<ResetOriginEndpointStateError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the MediaPackage resource that you’re adding tags to.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueContains a map of the key-value pairs for the resource tag or tags assigned to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the MediaPackage resource that you’re removing tags from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe list of tag keys to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_channel(&self) -> UpdateChannelFluentBuilder
pub fn update_channel(&self) -> UpdateChannelFluentBuilder
Constructs a fluent builder for the UpdateChannel
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
e_tag(impl Into<String>)
/set_e_tag(Option<String>)
:
required: falseThe expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource’s current entity tag, the update request will be rejected.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAny descriptive information that you want to add to the channel for future identification purposes.
input_switch_configuration(InputSwitchConfiguration)
/set_input_switch_configuration(Option<InputSwitchConfiguration>)
:
required: falseThe configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when
InputType
isCMAF
.output_header_configuration(OutputHeaderConfiguration)
/set_output_header_configuration(Option<OutputHeaderConfiguration>)
:
required: falseThe settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when
InputType
isCMAF
.
- On success, responds with
UpdateChannelOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
created_at(DateTime)
:The date and time the channel was created.
modified_at(DateTime)
:The date and time the channel was modified.
description(Option<String>)
:The description for your channel.
ingest_endpoints(Option<Vec::<IngestEndpoint>>)
:The list of ingest endpoints.
input_type(Option<InputType>)
:The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS
- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF
- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
-
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel.
input_switch_configuration(Option<InputSwitchConfiguration>)
:The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when
InputType
isCMAF
.output_header_configuration(Option<OutputHeaderConfiguration>)
:The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when
InputType
isCMAF
.
- On failure, responds with
SdkError<UpdateChannelError>
Source§impl Client
impl Client
Sourcepub fn update_channel_group(&self) -> UpdateChannelGroupFluentBuilder
pub fn update_channel_group(&self) -> UpdateChannelGroupFluentBuilder
Constructs a fluent builder for the UpdateChannelGroup
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
e_tag(impl Into<String>)
/set_e_tag(Option<String>)
:
required: falseThe expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource’s current entity tag, the update request will be rejected.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAny descriptive information that you want to add to the channel group for future identification purposes.
- On success, responds with
UpdateChannelGroupOutput
with field(s):channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
arn(String)
:The Amazon Resource Name (ARN) associated with the resource.
egress_domain(String)
:The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
created_at(DateTime)
:The date and time the channel group was created.
modified_at(DateTime)
:The date and time the channel group was modified.
description(Option<String>)
:The description for your channel group.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the channel group.
- On failure, responds with
SdkError<UpdateChannelGroupError>
Source§impl Client
impl Client
Sourcepub fn update_origin_endpoint(&self) -> UpdateOriginEndpointFluentBuilder
pub fn update_origin_endpoint(&self) -> UpdateOriginEndpointFluentBuilder
Constructs a fluent builder for the UpdateOriginEndpoint
operation.
- The fluent builder is configurable:
channel_group_name(impl Into<String>)
/set_channel_group_name(Option<String>)
:
required: trueThe name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: trueThe name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(impl Into<String>)
/set_origin_endpoint_name(Option<String>)
:
required: trueThe name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
container_type(ContainerType)
/set_container_type(Option<ContainerType>)
:
required: trueThe type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
segment(Segment)
/set_segment(Option<Segment>)
:
required: falseThe segment configuration, including the segment name, duration, and other configuration values.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAny descriptive information that you want to add to the origin endpoint for future identification purposes.
startover_window_seconds(i32)
/set_startover_window_seconds(Option<i32>)
:
required: falseThe size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
hls_manifests(CreateHlsManifestConfiguration)
/set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>)
:
required: falseAn HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration)
/set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>)
:
required: falseA low-latency HLS manifest configuration.
dash_manifests(CreateDashManifestConfiguration)
/set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>)
:
required: falseA DASH manifest configuration.
force_endpoint_error_configuration(ForceEndpointErrorConfiguration)
/set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)
:
required: falseThe failover settings for the endpoint.
e_tag(impl Into<String>)
/set_e_tag(Option<String>)
:
required: falseThe expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource’s current entity tag, the update request will be rejected.
- On success, responds with
UpdateOriginEndpointOutput
with field(s):arn(String)
:The ARN associated with the resource.
channel_group_name(String)
:The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name(String)
:The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
origin_endpoint_name(String)
:The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
container_type(ContainerType)
:The type of container attached to this origin endpoint.
segment(Option<Segment>)
:The segment configuration, including the segment name, duration, and other configuration values.
created_at(DateTime)
:The date and time the origin endpoint was created.
modified_at(DateTime)
:The date and time the origin endpoint was modified.
description(Option<String>)
:The description of the origin endpoint.
startover_window_seconds(Option<i32>)
:The size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)
:An HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)
:A low-latency HLS manifest configuration.
force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)
:The failover settings for the endpoint.
e_tag(Option<String>)
:The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
tags(Option<HashMap::<String, String>>)
:The comma-separated list of tag key:value pairs assigned to the origin endpoint.
dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)
:A DASH manifest configuration.
- On failure, responds with
SdkError<UpdateOriginEndpointError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_harvest_job_finished(&self) -> HarvestJobFinishedFluentBuilder
fn wait_until_harvest_job_finished(&self) -> HarvestJobFinishedFluentBuilder
harvest_job_finished
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);