Struct aws_sdk_mediapackagev2::client::Client
source · 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 Config
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 ListTagsForResource
operation has
a Client::list_tags_for_resource
, 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.list_tags_for_resource()
.resource_arn("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.
Implementations§
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.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseEnter any descriptive text that helps you to identify the channel.
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.
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.
- 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_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.
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.
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.
description(Option<String>)
:The description for your channel.
ingest_endpoints(Option<Vec::<IngestEndpoint>>)
:The list of ingest endpoints.
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.
- 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_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.
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.
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<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_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 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.
- 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.
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.
- 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.
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.
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§
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> 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 more