Struct Client 

pub struct Client { /* private fields */ }

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

impl Client

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: true
    

    The 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: true
    

    The name of the channel from which the harvest job is running.

    
    
  • origin_endpoint_name(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    The 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: true
    

    The 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: false
    

    The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.

    
    
• On success, responds with CancelHarvestJobOutput
• On failure, responds with SdkError<CancelHarvestJobError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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. You can’t change the name after you create the channel.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    
    
  • input_type(InputType) / set_input_type(Option<InputType>):
    required: false
    

    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).

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Enter any descriptive text that helps you to identify the channel.

    
    
  • input_switch_configuration(InputSwitchConfiguration) / set_input_switch_configuration(Option<InputSwitchConfiguration>):
    required: false
    

    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 is CMAF.

    
    
  • output_header_configuration(OutputHeaderConfiguration) / set_output_header_configuration(Option<OutputHeaderConfiguration>):
    required: false
    

    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 is CMAF.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A 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 is CMAF.

  • 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 is CMAF.

• On failure, responds with SdkError<CreateChannelError>

impl Client

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: true
    

    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. 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: false
    

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Enter 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: false
    

    A 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>

impl Client

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: true
    

    The name of the channel group containing the channel from which to harvest content.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel from which to harvest content.

    
    
  • origin_endpoint_name(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    The name of the origin endpoint from which to harvest content.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the harvest job.

    
    
  • harvested_manifests(HarvestedManifests) / set_harvested_manifests(Option<HarvestedManifests>):
    required: true
    

    A list of manifests to be harvested.

    
    
  • schedule_configuration(HarvesterScheduleConfiguration) / set_schedule_configuration(Option<HarvesterScheduleConfiguration>):
    required: true
    

    The configuration for when the harvest job should run, including start and end times.

    
    
  • destination(Destination) / set_destination(Option<Destination>):
    required: true
    

    The S3 destination where the harvested content will be placed.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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: false
    

    A 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: false
    

    A 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    The 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: true
    

    The 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: false
    

    The segment configuration, including the segment name, duration, and other configuration values.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Enter any descriptive text that helps you to identify the origin endpoint.

    
    
  • startover_window_seconds(i32) / set_startover_window_seconds(Option<i32>):
    required: false
    

    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).

    
    
  • hls_manifests(CreateHlsManifestConfiguration) / set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>):
    required: false
    

    An HTTP live streaming (HLS) manifest configuration.

    
    
  • low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration) / set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>):
    required: false
    

    A low-latency HLS manifest configuration.

    
    
  • dash_manifests(CreateDashManifestConfiguration) / set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>):
    required: false
    

    A DASH manifest configuration.

    
    
  • mss_manifests(CreateMssManifestConfiguration) / set_mss_manifests(Option<Vec::<CreateMssManifestConfiguration>>):
    required: false
    

    A list of Microsoft Smooth Streaming (MSS) manifest configurations for the origin endpoint. You can configure multiple MSS manifests to provide different streaming experiences or to support different client requirements.

    
    
  • force_endpoint_error_configuration(ForceEndpointErrorConfiguration) / set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>):
    required: false
    

    The failover settings for the endpoint.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A 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.

  • mss_manifests(Option<Vec::<GetMssManifestConfiguration>>):

    The Microsoft Smooth Streaming (MSS) manifest configurations that were created for this origin endpoint.

  • 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteChannelOutput
• On failure, responds with SdkError<DeleteChannelError>

impl Client

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: true
    

    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.

    
    
• On success, responds with DeleteChannelGroupOutput
• On failure, responds with SdkError<DeleteChannelGroupError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteChannelPolicyOutput
• On failure, responds with SdkError<DeleteChannelPolicyError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteOriginEndpointOutput
• On failure, responds with SdkError<DeleteOriginEndpointError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteOriginEndpointPolicyOutput
• On failure, responds with SdkError<DeleteOriginEndpointPolicyError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
• 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 is CMAF.

  • 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 is CMAF.

• On failure, responds with SdkError<GetChannelError>

impl Client

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: true
    

    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.

    
    
• 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
• 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>

impl Client

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: true
    

    The name of the channel group containing the channel associated with the harvest job.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel associated with the harvest job.

    
    
  • origin_endpoint_name(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    The name of the origin endpoint associated with the harvest job.

    
    
  • harvest_job_name(impl Into<String>) / set_harvest_job_name(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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.

    
    
• 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.

  • mss_manifests(Option<Vec::<GetMssManifestConfiguration>>):

    The Microsoft Smooth Streaming (MSS) manifest configurations associated with this origin endpoint.

  • 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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.

    
    
• 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.

  • cdn_auth_configuration(Option<CdnAuthConfiguration>):

    The settings for using authorization headers between the MediaPackage endpoint and your CDN.

    For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.

• On failure, responds with SdkError<GetOriginEndpointPolicyError>

impl Client

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: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The 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>

impl Client

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: true
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The 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>

impl Client

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: true
    

    The 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: false
    

    The 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: false
    

    The 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: false
    

    The 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: false
    

    The 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: false
    

    A 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The 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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The policy to attach to the specified channel.

    
    
• On success, responds with PutChannelPolicyOutput
• On failure, responds with SdkError<PutChannelPolicyError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The policy to attach to the specified origin endpoint.

    
    
  • cdn_auth_configuration(CdnAuthConfiguration) / set_cdn_auth_configuration(Option<CdnAuthConfiguration>):
    required: false
    

    The settings for using authorization headers between the MediaPackage endpoint and your CDN.

    For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.

    
    
• On success, responds with PutOriginEndpointPolicyOutput
• On failure, responds with SdkError<PutOriginEndpointPolicyError>

impl Client

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: true
    

    The name of the channel group that contains the channel that you are resetting.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    The 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: true
    

    The 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: true
    

    The 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>

impl Client

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: true
    

    The 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: true
    

    Contains 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>

impl Client

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: true
    

    The ARN of the MediaPackage resource that you’re removing tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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.

    
    
  • e_tag(impl Into<String>) / set_e_tag(Option<String>):
    required: false
    

    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.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Any 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: false
    

    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 is CMAF.

    
    
  • output_header_configuration(OutputHeaderConfiguration) / set_output_header_configuration(Option<OutputHeaderConfiguration>):
    required: false
    

    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 is CMAF.

    
    
• 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 is CMAF.

  • 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 is CMAF.

• On failure, responds with SdkError<UpdateChannelError>

impl Client

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: true
    

    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.

    
    
  • e_tag(impl Into<String>) / set_e_tag(Option<String>):
    required: false
    

    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.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Any 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>

impl Client

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: true
    

    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(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_origin_endpoint_name(Option<String>):
    required: true
    

    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) / set_container_type(Option<ContainerType>):
    required: true
    

    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.

    
    
  • segment(Segment) / set_segment(Option<Segment>):
    required: false
    

    The segment configuration, including the segment name, duration, and other configuration values.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Any 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: false
    

    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).

    
    
  • hls_manifests(CreateHlsManifestConfiguration) / set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>):
    required: false
    

    An HTTP live streaming (HLS) manifest configuration.

    
    
  • low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration) / set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>):
    required: false
    

    A low-latency HLS manifest configuration.

    
    
  • dash_manifests(CreateDashManifestConfiguration) / set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>):
    required: false
    

    A DASH manifest configuration.

    
    
  • mss_manifests(CreateMssManifestConfiguration) / set_mss_manifests(Option<Vec::<CreateMssManifestConfiguration>>):
    required: false
    

    A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.

    
    
  • force_endpoint_error_configuration(ForceEndpointErrorConfiguration) / set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>):
    required: false
    

    The failover settings for the endpoint.

    
    
  • e_tag(impl Into<String>) / set_e_tag(Option<String>):
    required: false
    

    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.

    
    
• 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.

  • mss_manifests(Option<Vec::<GetMssManifestConfiguration>>):

    The updated Microsoft Smooth Streaming (MSS) manifest configurations for this origin endpoint.

  • 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>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_harvest_job_finished(&self) -> HarvestJobFinishedFluentBuilder

Wait for harvest_job_finished