aws_sdk_mediapackagev2/client/update_origin_endpoint.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`UpdateOriginEndpoint`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`channel_group_name(impl Into<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>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.</p><br>
7 /// - [`channel_name(impl Into<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_channel_name):<br>required: **true**<br><p>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.</p><br>
8 /// - [`origin_endpoint_name(impl Into<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_origin_endpoint_name):<br>required: **true**<br><p>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.</p><br>
9 /// - [`container_type(ContainerType)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::container_type) / [`set_container_type(Option<ContainerType>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_container_type):<br>required: **true**<br><p>The 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.</p><br>
10 /// - [`segment(Segment)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::segment) / [`set_segment(Option<Segment>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_segment):<br>required: **false**<br><p>The segment configuration, including the segment name, duration, and other configuration values.</p><br>
11 /// - [`description(impl Into<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_description):<br>required: **false**<br><p>Any descriptive information that you want to add to the origin endpoint for future identification purposes.</p><br>
12 /// - [`startover_window_seconds(i32)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::startover_window_seconds) / [`set_startover_window_seconds(Option<i32>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_startover_window_seconds):<br>required: **false**<br><p>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. The maximum startover window is 1,209,600 seconds (14 days).</p><br>
13 /// - [`hls_manifests(CreateHlsManifestConfiguration)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::hls_manifests) / [`set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_hls_manifests):<br>required: **false**<br><p>An HTTP live streaming (HLS) manifest configuration.</p><br>
14 /// - [`low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::low_latency_hls_manifests) / [`set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_low_latency_hls_manifests):<br>required: **false**<br><p>A low-latency HLS manifest configuration.</p><br>
15 /// - [`dash_manifests(CreateDashManifestConfiguration)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::dash_manifests) / [`set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_dash_manifests):<br>required: **false**<br><p>A DASH manifest configuration.</p><br>
16 /// - [`mss_manifests(CreateMssManifestConfiguration)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::mss_manifests) / [`set_mss_manifests(Option<Vec::<CreateMssManifestConfiguration>>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_mss_manifests):<br>required: **false**<br><p>A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.</p><br>
17 /// - [`force_endpoint_error_configuration(ForceEndpointErrorConfiguration)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::force_endpoint_error_configuration) / [`set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_force_endpoint_error_configuration):<br>required: **false**<br><p>The failover settings for the endpoint.</p><br>
18 /// - [`e_tag(impl Into<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::e_tag) / [`set_e_tag(Option<String>)`](crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::set_e_tag):<br>required: **false**<br><p>The 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.</p><br>
19 /// - On success, responds with [`UpdateOriginEndpointOutput`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput) with field(s):
20 /// - [`arn(String)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::arn): <p>The ARN associated with the resource.</p>
21 /// - [`channel_group_name(String)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::channel_group_name): <p>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.</p>
22 /// - [`channel_name(String)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::channel_name): <p>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.</p>
23 /// - [`origin_endpoint_name(String)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::origin_endpoint_name): <p>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.</p>
24 /// - [`container_type(ContainerType)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::container_type): <p>The type of container attached to this origin endpoint.</p>
25 /// - [`segment(Option<Segment>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::segment): <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
26 /// - [`created_at(DateTime)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::created_at): <p>The date and time the origin endpoint was created.</p>
27 /// - [`modified_at(DateTime)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::modified_at): <p>The date and time the origin endpoint was modified.</p>
28 /// - [`description(Option<String>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::description): <p>The description of the origin endpoint.</p>
29 /// - [`startover_window_seconds(Option<i32>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::startover_window_seconds): <p>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.</p>
30 /// - [`hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::hls_manifests): <p>An HTTP live streaming (HLS) manifest configuration.</p>
31 /// - [`low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::low_latency_hls_manifests): <p>A low-latency HLS manifest configuration.</p>
32 /// - [`mss_manifests(Option<Vec::<GetMssManifestConfiguration>>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::mss_manifests): <p>The updated Microsoft Smooth Streaming (MSS) manifest configurations for this origin endpoint.</p>
33 /// - [`force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::force_endpoint_error_configuration): <p>The failover settings for the endpoint.</p>
34 /// - [`e_tag(Option<String>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::e_tag): <p>The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.</p>
35 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::tags): <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
36 /// - [`dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)`](crate::operation::update_origin_endpoint::UpdateOriginEndpointOutput::dash_manifests): <p>A DASH manifest configuration.</p>
37 /// - On failure, responds with [`SdkError<UpdateOriginEndpointError>`](crate::operation::update_origin_endpoint::UpdateOriginEndpointError)
38 pub fn update_origin_endpoint(&self) -> crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder {
39 crate::operation::update_origin_endpoint::builders::UpdateOriginEndpointFluentBuilder::new(self.handle.clone())
40 }
41}