Struct aws_sdk_mediapackage::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Elemental MediaPackage
Client for invoking operations on AWS Elemental MediaPackage. Each operation on AWS Elemental MediaPackage 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_mediapackage::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_mediapackage::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 ConfigureLogs
operation has
a Client::configure_logs
, 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.configure_logs()
.id("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 configure_logs(&self) -> ConfigureLogsFluentBuilder
pub fn configure_logs(&self) -> ConfigureLogsFluentBuilder
Constructs a fluent builder for the ConfigureLogs
operation.
- The fluent builder is configurable:
egress_access_logs(EgressAccessLogs)
/set_egress_access_logs(Option<EgressAccessLogs>)
:
required: false
Configure egress access logging.id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the channel to log subscription.ingress_access_logs(IngressAccessLogs)
/set_ingress_access_logs(Option<IngressAccessLogs>)
:
required: false
Configure ingress access logging.
- On success, responds with
ConfigureLogsOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<ConfigureLogsError>
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:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A short text description of the Channel.id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is created.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of tags associated with a resource
- On success, responds with
CreateChannelOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<CreateChannelError>
source§impl Client
impl Client
sourcepub fn create_harvest_job(&self) -> CreateHarvestJobFluentBuilder
pub fn create_harvest_job(&self) -> CreateHarvestJobFluentBuilder
Constructs a fluent builder for the CreateHarvestJob
operation.
- The fluent builder is configurable:
end_time(impl Into<String>)
/set_end_time(Option<String>)
:
required: true
The end of the time-window which will be harvestedid(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submittedorigin_endpoint_id(impl Into<String>)
/set_origin_endpoint_id(Option<String>)
:
required: true
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.s3_destination(S3Destination)
/set_s3_destination(Option<S3Destination>)
:
required: true
Configuration parameters for where in an S3 bucket to place the harvested contentstart_time(impl Into<String>)
/set_start_time(Option<String>)
:
required: true
The start of the time-window which will be harvested
- On success, responds with
CreateHarvestJobOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the HarvestJob.channel_id(Option<String>)
: The ID of the Channel that the HarvestJob will harvest from.created_at(Option<String>)
: The date and time the HarvestJob was submitted.end_time(Option<String>)
: The end of the time-window which will be harvested.id(Option<String>)
: The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.origin_endpoint_id(Option<String>)
: The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.s3_destination(Option<S3Destination>)
: Configuration parameters for where in an S3 bucket to place the harvested contentstart_time(Option<String>)
: The start of the time-window which will be harvested.status(Option<Status>)
: The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
- On failure, responds with
SdkError<CreateHarvestJobError>
source§impl Client
impl Client
sourcepub fn create_origin_endpoint(&self) -> CreateOriginEndpointFluentBuilder
pub fn create_origin_endpoint(&self) -> CreateOriginEndpointFluentBuilder
Constructs a fluent builder for the CreateOriginEndpoint
operation.
- The fluent builder is configurable:
authorization(Authorization)
/set_authorization(Option<Authorization>)
:
required: false
CDN Authorization credentialschannel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.cmaf_package(CmafPackageCreateOrUpdateParameters)
/set_cmaf_package(Option<CmafPackageCreateOrUpdateParameters>)
:
required: false
A Common Media Application Format (CMAF) packaging configuration.dash_package(DashPackage)
/set_dash_package(Option<DashPackage>)
:
required: false
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A short text description of the OriginEndpoint.hls_package(HlsPackage)
/set_hls_package(Option<HlsPackage>)
:
required: false
An HTTP Live Streaming (HLS) packaging configuration.id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.manifest_name(impl Into<String>)
/set_manifest_name(Option<String>)
:
required: false
A short string that will be used as the filename of the OriginEndpoint URL (defaults to “index”).mss_package(MssPackage)
/set_mss_package(Option<MssPackage>)
:
required: false
A Microsoft Smooth Streaming (MSS) packaging configuration.origination(Origination)
/set_origination(Option<Origination>)
:
required: false
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling originationstartover_window_seconds(i32)
/set_startover_window_seconds(Option<i32>)
:
required: false
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of tags associated with a resourcetime_delay_seconds(i32)
/set_time_delay_seconds(Option<i32>)
:
required: false
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.whitelist(impl Into<String>)
/set_whitelist(Option<Vec::<String>>)
:
required: false
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- On success, responds with
CreateOriginEndpointOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the OriginEndpoint.authorization(Option<Authorization>)
: CDN Authorization credentialschannel_id(Option<String>)
: The ID of the Channel the OriginEndpoint is associated with.cmaf_package(Option<CmafPackage>)
: A Common Media Application Format (CMAF) packaging configuration.created_at(Option<String>)
: The date and time the OriginEndpoint was created.dash_package(Option<DashPackage>)
: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.description(Option<String>)
: A short text description of the OriginEndpoint.hls_package(Option<HlsPackage>)
: An HTTP Live Streaming (HLS) packaging configuration.id(Option<String>)
: The ID of the OriginEndpoint.manifest_name(Option<String>)
: A short string appended to the end of the OriginEndpoint URL.mss_package(Option<MssPackage>)
: A Microsoft Smooth Streaming (MSS) packaging configuration.origination(Option<Origination>)
: Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling originationstartover_window_seconds(Option<i32>)
: Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resourcetime_delay_seconds(Option<i32>)
: Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.url(Option<String>)
: The URL of the packaged OriginEndpoint for consumption.whitelist(Option<Vec::<String>>)
: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- 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:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the Channel to delete.
- On success, responds with
DeleteChannelOutput
- On failure, responds with
SdkError<DeleteChannelError>
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:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the OriginEndpoint to delete.
- On success, responds with
DeleteOriginEndpointOutput
- On failure, responds with
SdkError<DeleteOriginEndpointError>
source§impl Client
impl Client
sourcepub fn describe_channel(&self) -> DescribeChannelFluentBuilder
pub fn describe_channel(&self) -> DescribeChannelFluentBuilder
Constructs a fluent builder for the DescribeChannel
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of a Channel.
- On success, responds with
DescribeChannelOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<DescribeChannelError>
source§impl Client
impl Client
sourcepub fn describe_harvest_job(&self) -> DescribeHarvestJobFluentBuilder
pub fn describe_harvest_job(&self) -> DescribeHarvestJobFluentBuilder
Constructs a fluent builder for the DescribeHarvestJob
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the HarvestJob.
- On success, responds with
DescribeHarvestJobOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the HarvestJob.channel_id(Option<String>)
: The ID of the Channel that the HarvestJob will harvest from.created_at(Option<String>)
: The date and time the HarvestJob was submitted.end_time(Option<String>)
: The end of the time-window which will be harvested.id(Option<String>)
: The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.origin_endpoint_id(Option<String>)
: The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.s3_destination(Option<S3Destination>)
: Configuration parameters for where in an S3 bucket to place the harvested contentstart_time(Option<String>)
: The start of the time-window which will be harvested.status(Option<Status>)
: The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
- On failure, responds with
SdkError<DescribeHarvestJobError>
source§impl Client
impl Client
sourcepub fn describe_origin_endpoint(&self) -> DescribeOriginEndpointFluentBuilder
pub fn describe_origin_endpoint(&self) -> DescribeOriginEndpointFluentBuilder
Constructs a fluent builder for the DescribeOriginEndpoint
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the OriginEndpoint.
- On success, responds with
DescribeOriginEndpointOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the OriginEndpoint.authorization(Option<Authorization>)
: CDN Authorization credentialschannel_id(Option<String>)
: The ID of the Channel the OriginEndpoint is associated with.cmaf_package(Option<CmafPackage>)
: A Common Media Application Format (CMAF) packaging configuration.created_at(Option<String>)
: The date and time the OriginEndpoint was created.dash_package(Option<DashPackage>)
: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.description(Option<String>)
: A short text description of the OriginEndpoint.hls_package(Option<HlsPackage>)
: An HTTP Live Streaming (HLS) packaging configuration.id(Option<String>)
: The ID of the OriginEndpoint.manifest_name(Option<String>)
: A short string appended to the end of the OriginEndpoint URL.mss_package(Option<MssPackage>)
: A Microsoft Smooth Streaming (MSS) packaging configuration.origination(Option<Origination>)
: Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling originationstartover_window_seconds(Option<i32>)
: Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resourcetime_delay_seconds(Option<i32>)
: Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.url(Option<String>)
: The URL of the packaged OriginEndpoint for consumption.whitelist(Option<Vec::<String>>)
: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- On failure, responds with
SdkError<DescribeOriginEndpointError>
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:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Upper bound on number of records to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to resume pagination from the end of a previous request.
- On success, responds with
ListChannelsOutput
with field(s):channels(Option<Vec::<Channel>>)
: A list of Channel records.next_token(Option<String>)
: A token that can be used to resume pagination from the end of the collection.
- On failure, responds with
SdkError<ListChannelsError>
source§impl Client
impl Client
sourcepub fn list_harvest_jobs(&self) -> ListHarvestJobsFluentBuilder
pub fn list_harvest_jobs(&self) -> ListHarvestJobsFluentBuilder
Constructs a fluent builder for the ListHarvestJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
include_channel_id(impl Into<String>)
/set_include_channel_id(Option<String>)
:
required: false
When specified, the request will return only HarvestJobs associated with the given Channel ID.include_status(impl Into<String>)
/set_include_status(Option<String>)
:
required: false
When specified, the request will return only HarvestJobs in the given status.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The upper bound on the number of records to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to resume pagination from the end of a previous request.
- On success, responds with
ListHarvestJobsOutput
with field(s):harvest_jobs(Option<Vec::<HarvestJob>>)
: A list of HarvestJob records.next_token(Option<String>)
: A token that can be used to resume pagination from the end of the collection.
- On failure, responds with
SdkError<ListHarvestJobsError>
source§impl Client
impl Client
sourcepub fn list_origin_endpoints(&self) -> ListOriginEndpointsFluentBuilder
pub fn list_origin_endpoints(&self) -> ListOriginEndpointsFluentBuilder
Constructs a fluent builder for the ListOriginEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: false
When specified, the request will return only OriginEndpoints associated with the given Channel ID.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The upper bound on the number of records to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to resume pagination from the end of a previous request.
- On success, responds with
ListOriginEndpointsOutput
with field(s):next_token(Option<String>)
: A token that can be used to resume pagination from the end of the collection.origin_endpoints(Option<Vec::<OriginEndpoint>>)
: A list of OriginEndpoint records.
- 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: true
(undocumented)
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
: (undocumented)
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn rotate_channel_credentials(
&self
) -> RotateChannelCredentialsFluentBuilder
👎Deprecated: This API is deprecated. Please use RotateIngestEndpointCredentials instead
pub fn rotate_channel_credentials( &self ) -> RotateChannelCredentialsFluentBuilder
Constructs a fluent builder for the RotateChannelCredentials
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the channel to update.
- On success, responds with
RotateChannelCredentialsOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<RotateChannelCredentialsError>
source§impl Client
impl Client
sourcepub fn rotate_ingest_endpoint_credentials(
&self
) -> RotateIngestEndpointCredentialsFluentBuilder
pub fn rotate_ingest_endpoint_credentials( &self ) -> RotateIngestEndpointCredentialsFluentBuilder
Constructs a fluent builder for the RotateIngestEndpointCredentials
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the channel the IngestEndpoint is on.ingest_endpoint_id(impl Into<String>)
/set_ingest_endpoint_id(Option<String>)
:
required: true
The id of the IngestEndpoint whose credentials should be rotated
- On success, responds with
RotateIngestEndpointCredentialsOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<RotateIngestEndpointCredentialsError>
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: true
(undocumented)tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: true
(undocumented)
- 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: true
(undocumented)tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
The key(s) of tag to be deleted
- 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:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A short text description of the Channel.id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the Channel to update.
- On success, responds with
UpdateChannelOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the Channel.created_at(Option<String>)
: The date and time the Channel was created.description(Option<String>)
: A short text description of the Channel.egress_access_logs(Option<EgressAccessLogs>)
: Configure egress access logging.hls_ingest(Option<HlsIngest>)
: An HTTP Live Streaming (HLS) ingest resource configuration.id(Option<String>)
: The ID of the Channel.ingress_access_logs(Option<IngressAccessLogs>)
: Configure ingress access logging.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resource
- On failure, responds with
SdkError<UpdateChannelError>
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:
authorization(Authorization)
/set_authorization(Option<Authorization>)
:
required: false
CDN Authorization credentialscmaf_package(CmafPackageCreateOrUpdateParameters)
/set_cmaf_package(Option<CmafPackageCreateOrUpdateParameters>)
:
required: false
A Common Media Application Format (CMAF) packaging configuration.dash_package(DashPackage)
/set_dash_package(Option<DashPackage>)
:
required: false
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A short text description of the OriginEndpoint.hls_package(HlsPackage)
/set_hls_package(Option<HlsPackage>)
:
required: false
An HTTP Live Streaming (HLS) packaging configuration.id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The ID of the OriginEndpoint to update.manifest_name(impl Into<String>)
/set_manifest_name(Option<String>)
:
required: false
A short string that will be appended to the end of the Endpoint URL.mss_package(MssPackage)
/set_mss_package(Option<MssPackage>)
:
required: false
A Microsoft Smooth Streaming (MSS) packaging configuration.origination(Origination)
/set_origination(Option<Origination>)
:
required: false
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling originationstartover_window_seconds(i32)
/set_startover_window_seconds(Option<i32>)
:
required: false
Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.time_delay_seconds(i32)
/set_time_delay_seconds(Option<i32>)
:
required: false
Amount of delay (in seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.whitelist(impl Into<String>)
/set_whitelist(Option<Vec::<String>>)
:
required: false
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- On success, responds with
UpdateOriginEndpointOutput
with field(s):arn(Option<String>)
: The Amazon Resource Name (ARN) assigned to the OriginEndpoint.authorization(Option<Authorization>)
: CDN Authorization credentialschannel_id(Option<String>)
: The ID of the Channel the OriginEndpoint is associated with.cmaf_package(Option<CmafPackage>)
: A Common Media Application Format (CMAF) packaging configuration.created_at(Option<String>)
: The date and time the OriginEndpoint was created.dash_package(Option<DashPackage>)
: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.description(Option<String>)
: A short text description of the OriginEndpoint.hls_package(Option<HlsPackage>)
: An HTTP Live Streaming (HLS) packaging configuration.id(Option<String>)
: The ID of the OriginEndpoint.manifest_name(Option<String>)
: A short string appended to the end of the OriginEndpoint URL.mss_package(Option<MssPackage>)
: A Microsoft Smooth Streaming (MSS) packaging configuration.origination(Option<Origination>)
: Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling originationstartover_window_seconds(Option<i32>)
: Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.tags(Option<HashMap::<String, String>>)
: A collection of tags associated with a resourcetime_delay_seconds(Option<i32>)
: Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.url(Option<String>)
: The URL of the packaged OriginEndpoint for consumption.whitelist(Option<Vec::<String>>)
: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- 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