aws_sdk_mediapackagev2/client/get_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 [`GetOriginEndpoint`](crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`channel_group_name(impl Into<String>)`](crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::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::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::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::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::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 /// - On success, responds with [`GetOriginEndpointOutput`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput) with field(s):
10 /// - [`arn(String)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::arn): <p>The Amazon Resource Name (ARN) associated with the resource.</p>
11 /// - [`channel_group_name(String)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::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>
12 /// - [`channel_name(String)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::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>
13 /// - [`origin_endpoint_name(String)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::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>
14 /// - [`container_type(ContainerType)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::container_type): <p>The type of container attached to this origin endpoint.</p>
15 /// - [`segment(Option<Segment>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::segment): <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
16 /// - [`created_at(DateTime)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::created_at): <p>The date and time the origin endpoint was created.</p>
17 /// - [`modified_at(DateTime)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::modified_at): <p>The date and time the origin endpoint was modified.</p>
18 /// - [`reset_at(Option<DateTime>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::reset_at): <p>The time that the origin endpoint was last reset.</p>
19 /// - [`description(Option<String>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::description): <p>The description for your origin endpoint.</p>
20 /// - [`startover_window_seconds(Option<i32>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::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>
21 /// - [`hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::hls_manifests): <p>An HTTP live streaming (HLS) manifest configuration.</p>
22 /// - [`low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::low_latency_hls_manifests): <p>A low-latency HLS manifest configuration.</p>
23 /// - [`dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::dash_manifests): <p>A DASH manifest configuration.</p>
24 /// - [`force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::force_endpoint_error_configuration): <p>The failover settings for the endpoint.</p>
25 /// - [`e_tag(Option<String>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::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>
26 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_origin_endpoint::GetOriginEndpointOutput::tags): <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
27 /// - On failure, responds with [`SdkError<GetOriginEndpointError>`](crate::operation::get_origin_endpoint::GetOriginEndpointError)
28 pub fn get_origin_endpoint(&self) -> crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder {
29 crate::operation::get_origin_endpoint::builders::GetOriginEndpointFluentBuilder::new(self.handle.clone())
30 }
31}