pub struct Client { /* private fields */ }
Expand description
Client for AWS Elemental MediaLive
Client for invoking operations on AWS Elemental MediaLive. Each operation on AWS Elemental MediaLive 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_medialive::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_medialive::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 AcceptInputDeviceTransfer
operation has
a Client::accept_input_device_transfer
, 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.accept_input_device_transfer()
.input_device_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.
§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§
Source§impl Client
impl Client
Sourcepub fn accept_input_device_transfer(
&self,
) -> AcceptInputDeviceTransferFluentBuilder
pub fn accept_input_device_transfer( &self, ) -> AcceptInputDeviceTransferFluentBuilder
Constructs a fluent builder for the AcceptInputDeviceTransfer
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to accept. For example, hd-123456789abcdef.
- On success, responds with
AcceptInputDeviceTransferOutput
- On failure, responds with
SdkError<AcceptInputDeviceTransferError>
Source§impl Client
impl Client
Sourcepub fn batch_delete(&self) -> BatchDeleteFluentBuilder
pub fn batch_delete(&self) -> BatchDeleteFluentBuilder
Constructs a fluent builder for the BatchDelete
operation.
- The fluent builder is configurable:
channel_ids(impl Into<String>)
/set_channel_ids(Option<Vec::<String>>)
:
required: false
List of channel IDsinput_ids(impl Into<String>)
/set_input_ids(Option<Vec::<String>>)
:
required: false
List of input IDsinput_security_group_ids(impl Into<String>)
/set_input_security_group_ids(Option<Vec::<String>>)
:
required: false
List of input security group IDsmultiplex_ids(impl Into<String>)
/set_multiplex_ids(Option<Vec::<String>>)
:
required: false
List of multiplex IDs
- On success, responds with
BatchDeleteOutput
with field(s):failed(Option<Vec::<BatchFailedResultModel>>)
: List of failed operationssuccessful(Option<Vec::<BatchSuccessfulResultModel>>)
: List of successful operations
- On failure, responds with
SdkError<BatchDeleteError>
Source§impl Client
impl Client
Sourcepub fn batch_start(&self) -> BatchStartFluentBuilder
pub fn batch_start(&self) -> BatchStartFluentBuilder
Constructs a fluent builder for the BatchStart
operation.
- The fluent builder is configurable:
channel_ids(impl Into<String>)
/set_channel_ids(Option<Vec::<String>>)
:
required: false
List of channel IDsmultiplex_ids(impl Into<String>)
/set_multiplex_ids(Option<Vec::<String>>)
:
required: false
List of multiplex IDs
- On success, responds with
BatchStartOutput
with field(s):failed(Option<Vec::<BatchFailedResultModel>>)
: List of failed operationssuccessful(Option<Vec::<BatchSuccessfulResultModel>>)
: List of successful operations
- On failure, responds with
SdkError<BatchStartError>
Source§impl Client
impl Client
Sourcepub fn batch_stop(&self) -> BatchStopFluentBuilder
pub fn batch_stop(&self) -> BatchStopFluentBuilder
Constructs a fluent builder for the BatchStop
operation.
- The fluent builder is configurable:
channel_ids(impl Into<String>)
/set_channel_ids(Option<Vec::<String>>)
:
required: false
List of channel IDsmultiplex_ids(impl Into<String>)
/set_multiplex_ids(Option<Vec::<String>>)
:
required: false
List of multiplex IDs
- On success, responds with
BatchStopOutput
with field(s):failed(Option<Vec::<BatchFailedResultModel>>)
: List of failed operationssuccessful(Option<Vec::<BatchSuccessfulResultModel>>)
: List of successful operations
- On failure, responds with
SdkError<BatchStopError>
Source§impl Client
impl Client
Sourcepub fn batch_update_schedule(&self) -> BatchUpdateScheduleFluentBuilder
pub fn batch_update_schedule(&self) -> BatchUpdateScheduleFluentBuilder
Constructs a fluent builder for the BatchUpdateSchedule
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Id of the channel whose schedule is being updated.creates(BatchScheduleActionCreateRequest)
/set_creates(Option<BatchScheduleActionCreateRequest>)
:
required: false
Schedule actions to create in the schedule.deletes(BatchScheduleActionDeleteRequest)
/set_deletes(Option<BatchScheduleActionDeleteRequest>)
:
required: false
Schedule actions to delete from the schedule.
- On success, responds with
BatchUpdateScheduleOutput
with field(s):creates(Option<BatchScheduleActionCreateResult>)
: Schedule actions created in the schedule.deletes(Option<BatchScheduleActionDeleteResult>)
: Schedule actions deleted from the schedule.
- On failure, responds with
SdkError<BatchUpdateScheduleError>
Source§impl Client
impl Client
Sourcepub fn cancel_input_device_transfer(
&self,
) -> CancelInputDeviceTransferFluentBuilder
pub fn cancel_input_device_transfer( &self, ) -> CancelInputDeviceTransferFluentBuilder
Constructs a fluent builder for the CancelInputDeviceTransfer
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to cancel. For example, hd-123456789abcdef.
- On success, responds with
CancelInputDeviceTransferOutput
- On failure, responds with
SdkError<CancelInputDeviceTransferError>
Source§impl Client
impl Client
Sourcepub fn claim_device(&self) -> ClaimDeviceFluentBuilder
pub fn claim_device(&self) -> ClaimDeviceFluentBuilder
Constructs a fluent builder for the ClaimDevice
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: false
The id of the device you want to claim.
- On success, responds with
ClaimDeviceOutput
- On failure, responds with
SdkError<ClaimDeviceError>
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:
cdi_input_specification(CdiInputSpecification)
/set_cdi_input_specification(Option<CdiInputSpecification>)
:
required: false
Specification of CDI inputs for this channelchannel_class(ChannelClass)
/set_channel_class(Option<ChannelClass>)
:
required: false
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(OutputDestination)
/set_destinations(Option<Vec::<OutputDestination>>)
:
required: false
Placeholder documentation for __listOfOutputDestinationencoder_settings(EncoderSettings)
/set_encoder_settings(Option<EncoderSettings>)
:
required: false
Encoder Settingsinput_attachments(InputAttachment)
/set_input_attachments(Option<Vec::<InputAttachment>>)
:
required: false
List of input attachments for channel.input_specification(InputSpecification)
/set_input_specification(Option<InputSpecification>)
:
required: false
Specification of network and file inputs for this channellog_level(LogLevel)
/set_log_level(Option<LogLevel>)
:
required: false
The log level to write to CloudWatch Logs.maintenance(MaintenanceCreateSettings)
/set_maintenance(Option<MaintenanceCreateSettings>)
:
required: false
Maintenance settings for this channel.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name of channel.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.reserved(impl Into<String>)
/set_reserved(Option<String>)
:
required: false
Deprecated field that’s only usable by whitelisted customers.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: false
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.vpc(VpcOutputSettings)
/set_vpc(Option<VpcOutputSettings>)
:
required: false
Settings for the VPC outputsanywhere_settings(AnywhereSettings)
/set_anywhere_settings(Option<AnywhereSettings>)
:
required: false
The Elemental Anywhere settings for this channel.channel_engine_version(ChannelEngineVersionRequest)
/set_channel_engine_version(Option<ChannelEngineVersionRequest>)
:
required: false
The desired engine version for this channel.dry_run(bool)
/set_dry_run(Option<bool>)
:
required: false
Placeholder documentation for __boolean
- On success, responds with
CreateChannelOutput
with field(s):channel(Option<Channel>)
: Placeholder documentation for Channel
- On failure, responds with
SdkError<CreateChannelError>
Source§impl Client
impl Client
Sourcepub fn create_channel_placement_group(
&self,
) -> CreateChannelPlacementGroupFluentBuilder
pub fn create_channel_placement_group( &self, ) -> CreateChannelPlacementGroupFluentBuilder
Constructs a fluent builder for the CreateChannelPlacementGroup
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.nodes(impl Into<String>)
/set_nodes(Option<Vec::<String>>)
:
required: false
An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can’t associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreateChannelPlacementGroupOutput
with field(s):arn(Option<String>)
: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.channels(Option<Vec::<String>>)
: Used in ListChannelPlacementGroupsResultcluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.id(Option<String>)
: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.name(Option<String>)
: The name that you specified for the ChannelPlacementGroup.nodes(Option<Vec::<String>>)
: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.state(Option<ChannelPlacementGroupState>)
: The current state of the ChannelPlacementGroup.
- On failure, responds with
SdkError<CreateChannelPlacementGroupError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_watch_alarm_template(
&self,
) -> CreateCloudWatchAlarmTemplateFluentBuilder
pub fn create_cloud_watch_alarm_template( &self, ) -> CreateCloudWatchAlarmTemplateFluentBuilder
Constructs a fluent builder for the CreateCloudWatchAlarmTemplate
operation.
- The fluent builder is configurable:
comparison_operator(CloudWatchAlarmTemplateComparisonOperator)
/set_comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)
:
required: true
The comparison operator used to compare the specified statistic and the threshold.datapoints_to_alarm(i32)
/set_datapoints_to_alarm(Option<i32>)
:
required: false
The number of datapoints within the evaluation period that must be breaching to trigger the alarm.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.evaluation_periods(i32)
/set_evaluation_periods(Option<i32>)
:
required: true
The number of periods over which data is compared to the specified threshold.group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: true
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: true
The name of the metric associated with the alarm. Must be compatible with targetResourceType.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
A resource’s name. Names must be unique within the scope of a resource type in a specific region.period(i32)
/set_period(Option<i32>)
:
required: true
The period, in seconds, over which the specified statistic is applied.statistic(CloudWatchAlarmTemplateStatistic)
/set_statistic(Option<CloudWatchAlarmTemplateStatistic>)
:
required: true
The statistic to apply to the alarm’s metric data.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Represents the tags associated with a resource.target_resource_type(CloudWatchAlarmTemplateTargetResourceType)
/set_target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)
:
required: true
The resource type this template should dynamically generate cloudwatch metric alarms for.threshold(f64)
/set_threshold(Option<f64>)
:
required: true
The threshold value to compare with the specified statistic.treat_missing_data(CloudWatchAlarmTemplateTreatMissingData)
/set_treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)
:
required: true
Specifies how missing data points are treated when evaluating the alarm’s condition.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.
- On success, responds with
CreateCloudWatchAlarmTemplateOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template’s ARN (Amazon Resource Name)comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)
: The comparison operator used to compare the specified statistic and the threshold.created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601datapoints_to_alarm(Option<i32>)
: The number of datapoints within the evaluation period that must be breaching to trigger the alarm.description(Option<String>)
: A resource’s optional description.evaluation_periods(Option<i32>)
: The number of periods over which data is compared to the specified threshold.group_id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: A cloudwatch alarm template’s id. AWS provided templates have ids that start withaws-
metric_name(Option<String>)
: The name of the metric associated with the alarm. Must be compatible with targetResourceType.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.period(Option<i32>)
: The period, in seconds, over which the specified statistic is applied.statistic(Option<CloudWatchAlarmTemplateStatistic>)
: The statistic to apply to the alarm’s metric data.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)
: The resource type this template should dynamically generate cloudwatch metric alarms for.threshold(Option<f64>)
: The threshold value to compare with the specified statistic.treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)
: Specifies how missing data points are treated when evaluating the alarm’s condition.
- On failure, responds with
SdkError<CreateCloudWatchAlarmTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_watch_alarm_template_group(
&self,
) -> CreateCloudWatchAlarmTemplateGroupFluentBuilder
pub fn create_cloud_watch_alarm_template_group( &self, ) -> CreateCloudWatchAlarmTemplateGroupFluentBuilder
Constructs a fluent builder for the CreateCloudWatchAlarmTemplateGroup
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Represents the tags associated with a resource.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.
- On success, responds with
CreateCloudWatchAlarmTemplateGroupOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<CreateCloudWatchAlarmTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn create_cluster(&self) -> CreateClusterFluentBuilder
pub fn create_cluster(&self) -> CreateClusterFluentBuilder
Constructs a fluent builder for the CreateCluster
operation.
- The fluent builder is configurable:
cluster_type(ClusterType)
/set_cluster_type(Option<ClusterType>)
:
required: false
Specify a type. All the Nodes that you later add to this Cluster must be this type of hardware. One Cluster instance can’t contain different hardware types. You won’t be able to change this parameter after you create the Cluster.instance_role_arn(impl Into<String>)
/set_instance_role_arn(Option<String>)
:
required: false
The ARN of the IAM role for the Node in this Cluster. The role must include all the operations that you expect these Node to perform. If necessary, create a role in IAM, then attach it here.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the types of Nodes in the Cluster. Names are case-sensitive.network_settings(ClusterNetworkSettingsCreateRequest)
/set_network_settings(Option<ClusterNetworkSettingsCreateRequest>)
:
required: false
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
The unique ID of the request.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreateClusterOutput
with field(s):arn(Option<String>)
: The ARN of this Cluster. It is automatically assigned when the Cluster is created.channel_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringcluster_type(Option<ClusterType>)
: The hardware type for the Clusterid(Option<String>)
: The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.instance_role_arn(Option<String>)
: The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.name(Option<String>)
: The name that you specified for the Cluster.network_settings(Option<ClusterNetworkSettings>)
: Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.state(Option<ClusterState>)
: The current state of the Cluster.
- On failure, responds with
SdkError<CreateClusterError>
Source§impl Client
impl Client
Sourcepub fn create_event_bridge_rule_template(
&self,
) -> CreateEventBridgeRuleTemplateFluentBuilder
pub fn create_event_bridge_rule_template( &self, ) -> CreateEventBridgeRuleTemplateFluentBuilder
Constructs a fluent builder for the CreateEventBridgeRuleTemplate
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.event_targets(EventBridgeRuleTemplateTarget)
/set_event_targets(Option<Vec::<EventBridgeRuleTemplateTarget>>)
:
required: false
Placeholder documentation for __listOfEventBridgeRuleTemplateTargetevent_type(EventBridgeRuleTemplateEventType)
/set_event_type(Option<EventBridgeRuleTemplateEventType>)
:
required: true
The type of event to match with the rule.group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: true
An eventbridge rule template group’s identifier. Can be either be its id or current name.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Represents the tags associated with a resource.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.
- On success, responds with
CreateEventBridgeRuleTemplateOutput
with field(s):arn(Option<String>)
: An eventbridge rule template’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.event_targets(Option<Vec::<EventBridgeRuleTemplateTarget>>)
: Placeholder documentation for __listOfEventBridgeRuleTemplateTargetevent_type(Option<EventBridgeRuleTemplateEventType>)
: The type of event to match with the rule.group_id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: An eventbridge rule template’s id. AWS provided templates have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<CreateEventBridgeRuleTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_event_bridge_rule_template_group(
&self,
) -> CreateEventBridgeRuleTemplateGroupFluentBuilder
pub fn create_event_bridge_rule_template_group( &self, ) -> CreateEventBridgeRuleTemplateGroupFluentBuilder
Constructs a fluent builder for the CreateEventBridgeRuleTemplateGroup
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Represents the tags associated with a resource.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.
- On success, responds with
CreateEventBridgeRuleTemplateGroupOutput
with field(s):arn(Option<String>)
: An eventbridge rule template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<CreateEventBridgeRuleTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn create_input(&self) -> CreateInputFluentBuilder
pub fn create_input(&self) -> CreateInputFluentBuilder
Constructs a fluent builder for the CreateInput
operation.
- The fluent builder is configurable:
destinations(InputDestinationRequest)
/set_destinations(Option<Vec::<InputDestinationRequest>>)
:
required: false
Destination settings for PUSH type inputs.input_devices(InputDeviceSettings)
/set_input_devices(Option<Vec::<InputDeviceSettings>>)
:
required: false
Settings for the devices.input_security_groups(impl Into<String>)
/set_input_security_groups(Option<Vec::<String>>)
:
required: false
A list of security groups referenced by IDs to attach to the input.media_connect_flows(MediaConnectFlowRequest)
/set_media_connect_flows(Option<Vec::<MediaConnectFlowRequest>>)
:
required: false
A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name of the input.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
Unique identifier of the request to ensure the request is handled exactly once in case of retries.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: false
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.sources(InputSourceRequest)
/set_sources(Option<Vec::<InputSourceRequest>>)
:
required: false
The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.r#type(InputType)
/set_type(Option<InputType>)
:
required: false
The different types of inputs that AWS Elemental MediaLive supports.vpc(InputVpcRequest)
/set_vpc(Option<InputVpcRequest>)
:
required: false
Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property.srt_settings(SrtSettingsRequest)
/set_srt_settings(Option<SrtSettingsRequest>)
:
required: false
The settings associated with an SRT input.input_network_location(InputNetworkLocation)
/set_input_network_location(Option<InputNetworkLocation>)
:
required: false
The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.multicast_settings(MulticastSettingsCreateRequest)
/set_multicast_settings(Option<MulticastSettingsCreateRequest>)
:
required: false
Multicast Input settings.smpte2110_receiver_group_settings(Smpte2110ReceiverGroupSettings)
/set_smpte2110_receiver_group_settings(Option<Smpte2110ReceiverGroupSettings>)
:
required: false
Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.sdi_sources(impl Into<String>)
/set_sdi_sources(Option<Vec::<String>>)
:
required: false
SDI Sources for this Input.
- On success, responds with
CreateInputOutput
with field(s):input(Option<Input>)
: Placeholder documentation for Input
- On failure, responds with
SdkError<CreateInputError>
Source§impl Client
impl Client
Sourcepub fn create_input_security_group(
&self,
) -> CreateInputSecurityGroupFluentBuilder
pub fn create_input_security_group( &self, ) -> CreateInputSecurityGroupFluentBuilder
Constructs a fluent builder for the CreateInputSecurityGroup
operation.
- The fluent builder is configurable:
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.whitelist_rules(InputWhitelistRuleCidr)
/set_whitelist_rules(Option<Vec::<InputWhitelistRuleCidr>>)
:
required: false
List of IPv4 CIDR addresses to whitelist
- On success, responds with
CreateInputSecurityGroupOutput
with field(s):security_group(Option<InputSecurityGroup>)
: An Input Security Group
- On failure, responds with
SdkError<CreateInputSecurityGroupError>
Source§impl Client
impl Client
Sourcepub fn create_multiplex(&self) -> CreateMultiplexFluentBuilder
pub fn create_multiplex(&self) -> CreateMultiplexFluentBuilder
Constructs a fluent builder for the CreateMultiplex
operation.
- The fluent builder is configurable:
availability_zones(impl Into<String>)
/set_availability_zones(Option<Vec::<String>>)
:
required: true
A list of availability zones for the multiplex. You must specify exactly two.multiplex_settings(MultiplexSettings)
/set_multiplex_settings(Option<MultiplexSettings>)
:
required: true
Configuration for a multiplex event.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
Name of multiplex.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: true
Unique request ID. This prevents retries from creating multiple resources.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreateMultiplexOutput
with field(s):multiplex(Option<Multiplex>)
: The newly created multiplex.
- On failure, responds with
SdkError<CreateMultiplexError>
Source§impl Client
impl Client
Sourcepub fn create_multiplex_program(&self) -> CreateMultiplexProgramFluentBuilder
pub fn create_multiplex_program(&self) -> CreateMultiplexProgramFluentBuilder
Constructs a fluent builder for the CreateMultiplexProgram
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
ID of the multiplex where the program is to be created.multiplex_program_settings(MultiplexProgramSettings)
/set_multiplex_program_settings(Option<MultiplexProgramSettings>)
:
required: true
The settings for this multiplex program.program_name(impl Into<String>)
/set_program_name(Option<String>)
:
required: true
Name of multiplex program.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: true
Unique request ID. This prevents retries from creating multiple resources.
- On success, responds with
CreateMultiplexProgramOutput
with field(s):multiplex_program(Option<MultiplexProgram>)
: The newly created multiplex program.
- On failure, responds with
SdkError<CreateMultiplexProgramError>
Source§impl Client
impl Client
Sourcepub fn create_network(&self) -> CreateNetworkFluentBuilder
pub fn create_network(&self) -> CreateNetworkFluentBuilder
Constructs a fluent builder for the CreateNetwork
operation.
- The fluent builder is configurable:
ip_pools(IpPoolCreateRequest)
/set_ip_pools(Option<Vec::<IpPoolCreateRequest>>)
:
required: false
An array of IpPoolCreateRequests that identify a collection of IP addresses in your network that you want to reserve for use in MediaLive Anywhere. MediaLiveAnywhere uses these IP addresses for Push inputs (in both Bridge and NATnetworks) and for output destinations (only in Bridge networks). EachIpPoolUpdateRequest specifies one CIDR block.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the type of traffic on the network. Names are case-sensitive.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.routes(RouteCreateRequest)
/set_routes(Option<Vec::<RouteCreateRequest>>)
:
required: false
An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreateNetworkOutput
with field(s):arn(Option<String>)
: The ARN of this Network. It is automatically assigned when the Network is created.associated_cluster_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringid(Option<String>)
: The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.ip_pools(Option<Vec::<IpPool>>)
: An array of IpPools in your organization’s network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.name(Option<String>)
: The name that you specified for the Network.routes(Option<Vec::<Route>>)
: An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.state(Option<NetworkState>)
: The current state of the Network. Only MediaLive Anywhere can change the state.
- On failure, responds with
SdkError<CreateNetworkError>
Source§impl Client
impl Client
Sourcepub fn create_node(&self) -> CreateNodeFluentBuilder
pub fn create_node(&self) -> CreateNodeFluentBuilder
Constructs a fluent builder for the CreateNode
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The user-specified name of the Node to be created.node_interface_mappings(NodeInterfaceMappingCreateRequest)
/set_node_interface_mappings(Option<Vec::<NodeInterfaceMappingCreateRequest>>)
:
required: false
Documentation update neededrequest_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.role(NodeRole)
/set_role(Option<NodeRole>)
:
required: false
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreateNodeOutput
with field(s):arn(Option<String>)
: The ARN of the Node. It is automatically assigned when the Node is created.channel_placement_groups(Option<Vec::<String>>)
: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.cluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.connection_state(Option<NodeConnectionState>)
: The current connection state of the Node.id(Option<String>)
: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.instance_arn(Option<String>)
: The ARN of the EC2 instance hosting the Node.name(Option<String>)
: The name that you specified for the Node.node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
: Documentation update neededrole(Option<NodeRole>)
: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.state(Option<NodeState>)
: The current state of the Node.sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)
: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
- On failure, responds with
SdkError<CreateNodeError>
Source§impl Client
impl Client
Sourcepub fn create_node_registration_script(
&self,
) -> CreateNodeRegistrationScriptFluentBuilder
pub fn create_node_registration_script( &self, ) -> CreateNodeRegistrationScriptFluentBuilder
Constructs a fluent builder for the CreateNodeRegistrationScript
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clusterid(impl Into<String>)
/set_id(Option<String>)
:
required: false
If you’re generating a re-registration script for an already existing node, this is where you provide the id.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z).node_interface_mappings(NodeInterfaceMapping)
/set_node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
:
required: false
Documentation update neededrequest_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.role(NodeRole)
/set_role(Option<NodeRole>)
:
required: false
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
- On success, responds with
CreateNodeRegistrationScriptOutput
with field(s):node_registration_script(Option<String>)
: A script that can be run on a Bring Your Own Device Elemental Anywhere system to create a node in a cluster.
- On failure, responds with
SdkError<CreateNodeRegistrationScriptError>
Source§impl Client
impl Client
Sourcepub fn create_partner_input(&self) -> CreatePartnerInputFluentBuilder
pub fn create_partner_input(&self) -> CreatePartnerInputFluentBuilder
Constructs a fluent builder for the CreatePartnerInput
operation.
- The fluent builder is configurable:
input_id(impl Into<String>)
/set_input_id(Option<String>)
:
required: true
Unique ID of the input.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
Unique identifier of the request to ensure the request is handled exactly once in case of retries.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.
- On success, responds with
CreatePartnerInputOutput
with field(s):input(Option<Input>)
: Placeholder documentation for Input
- On failure, responds with
SdkError<CreatePartnerInputError>
Source§impl Client
impl Client
Sourcepub fn create_sdi_source(&self) -> CreateSdiSourceFluentBuilder
pub fn create_sdi_source(&self) -> CreateSdiSourceFluentBuilder
Constructs a fluent builder for the CreateSdiSource
operation.
- The fluent builder is configurable:
mode(SdiSourceMode)
/set_mode(Option<SdiSourceMode>)
:
required: false
Applies only if the type is QUAD. Specify the mode for handling the quad-link signal: QUADRANT or INTERLEAVE.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.r#type(SdiSourceType)
/set_type(Option<SdiSourceType>)
:
required: false
Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.
- On success, responds with
CreateSdiSourceOutput
with field(s):sdi_source(Option<SdiSource>)
: Settings for the SDI source.
- On failure, responds with
SdkError<CreateSdiSourceError>
Source§impl Client
impl Client
Sourcepub fn create_signal_map(&self) -> CreateSignalMapFluentBuilder
pub fn create_signal_map(&self) -> CreateSignalMapFluentBuilder
Constructs a fluent builder for the CreateSignalMap
operation.
- The fluent builder is configurable:
cloud_watch_alarm_template_group_identifiers(impl Into<String>)
/set_cloud_watch_alarm_template_group_identifiers(Option<Vec::<String>>)
:
required: false
Placeholder documentation for __listOf__stringPatternSdescription(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.discovery_entry_point_arn(impl Into<String>)
/set_discovery_entry_point_arn(Option<String>)
:
required: true
A top-level supported AWS resource ARN to discovery a signal map from.event_bridge_rule_template_group_identifiers(impl Into<String>)
/set_event_bridge_rule_template_group_identifiers(Option<Vec::<String>>)
:
required: false
Placeholder documentation for __listOf__stringPatternSname(impl Into<String>)
/set_name(Option<String>)
:
required: true
A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Represents the tags associated with a resource.request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
An ID that you assign to a create request. This ID ensures idempotency when creating resources.
- On success, responds with
CreateSignalMapOutput
with field(s):arn(Option<String>)
: A signal map’s ARN (Amazon Resource Name)cloud_watch_alarm_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.discovery_entry_point_arn(Option<String>)
: A top-level supported AWS resource ARN to discovery a signal map from.error_message(Option<String>)
: Error message associated with a failed creation or failed update attempt of a signal map.event_bridge_rule_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097failed_media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an incomplete AWS media workflow as a graph.id(Option<String>)
: A signal map’s id.last_discovered_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601last_successful_monitor_deployment(Option<SuccessfulMonitorDeployment>)
: Represents the latest successful monitor deployment of a signal map.media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an AWS media workflow as a graph.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601monitor_changes_pending_deployment(Option<bool>)
: If true, there are pending monitor changes for this signal map that can be deployed.monitor_deployment(Option<MonitorDeployment>)
: Represents the latest monitor deployment of a signal map.name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.status(Option<SignalMapStatus>)
: A signal map’s current status which is dependent on its lifecycle actions or associated jobs.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<CreateSignalMapError>
Source§impl Client
impl Client
Constructs a fluent builder for the CreateTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
Placeholder documentation for __stringtags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Placeholder documentation for Tags
- On success, responds with
CreateTagsOutput
- On failure, responds with
SdkError<CreateTagsError>
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_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Unique ID of the channel.
- On success, responds with
DeleteChannelOutput
with field(s):arn(Option<String>)
: The unique arn of the channel.cdi_input_specification(Option<CdiInputSpecification>)
: Specification of CDI inputs for this channelchannel_class(Option<ChannelClass>)
: The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(Option<Vec::<OutputDestination>>)
: A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.egress_endpoints(Option<Vec::<ChannelEgressEndpoint>>)
: The endpoints where outgoing connections initiate fromencoder_settings(Option<EncoderSettings>)
: Encoder Settingsid(Option<String>)
: The unique id of the channel.input_attachments(Option<Vec::<InputAttachment>>)
: List of input attachments for channel.input_specification(Option<InputSpecification>)
: Specification of network and file inputs for this channellog_level(Option<LogLevel>)
: The log level being written to CloudWatch Logs.maintenance(Option<MaintenanceStatus>)
: Maintenance settings for this channel.name(Option<String>)
: The name of the channel. (user-mutable)pipeline_details(Option<Vec::<PipelineDetail>>)
: Runtime details for the pipelines of a running channel.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role assumed when running the Channel.state(Option<ChannelState>)
: Placeholder documentation for ChannelStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.vpc(Option<VpcOutputSettingsDescription>)
: Settings for VPC outputanywhere_settings(Option<DescribeAnywhereSettings>)
: Anywhere settings for this channel.channel_engine_version(Option<ChannelEngineVersionResponse>)
: Requested engine version for this channel.
- On failure, responds with
SdkError<DeleteChannelError>
Source§impl Client
impl Client
Sourcepub fn delete_channel_placement_group(
&self,
) -> DeleteChannelPlacementGroupFluentBuilder
pub fn delete_channel_placement_group( &self, ) -> DeleteChannelPlacementGroupFluentBuilder
Constructs a fluent builder for the DeleteChannelPlacementGroup
operation.
- The fluent builder is configurable:
channel_placement_group_id(impl Into<String>)
/set_channel_placement_group_id(Option<String>)
:
required: true
The ID of the channel placement group.cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.
- On success, responds with
DeleteChannelPlacementGroupOutput
with field(s):arn(Option<String>)
: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.channels(Option<Vec::<String>>)
: Used in ListChannelPlacementGroupsResultcluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.id(Option<String>)
: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.name(Option<String>)
: The name that you specified for the ChannelPlacementGroup.nodes(Option<Vec::<String>>)
: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.state(Option<ChannelPlacementGroupState>)
: The current state of the ChannelPlacementGroup.
- On failure, responds with
SdkError<DeleteChannelPlacementGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_cloud_watch_alarm_template(
&self,
) -> DeleteCloudWatchAlarmTemplateFluentBuilder
pub fn delete_cloud_watch_alarm_template( &self, ) -> DeleteCloudWatchAlarmTemplateFluentBuilder
Constructs a fluent builder for the DeleteCloudWatchAlarmTemplate
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template’s identifier. Can be either be its id or current name.
- On success, responds with
DeleteCloudWatchAlarmTemplateOutput
- On failure, responds with
SdkError<DeleteCloudWatchAlarmTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_cloud_watch_alarm_template_group(
&self,
) -> DeleteCloudWatchAlarmTemplateGroupFluentBuilder
pub fn delete_cloud_watch_alarm_template_group( &self, ) -> DeleteCloudWatchAlarmTemplateGroupFluentBuilder
Constructs a fluent builder for the DeleteCloudWatchAlarmTemplateGroup
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.
- On success, responds with
DeleteCloudWatchAlarmTemplateGroupOutput
- On failure, responds with
SdkError<DeleteCloudWatchAlarmTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_cluster(&self) -> DeleteClusterFluentBuilder
pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder
Constructs a fluent builder for the DeleteCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.
- On success, responds with
DeleteClusterOutput
with field(s):arn(Option<String>)
: The ARN of this Cluster. It is automatically assigned when the Cluster is created.channel_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringcluster_type(Option<ClusterType>)
: The hardware type for the Clusterid(Option<String>)
: The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.instance_role_arn(Option<String>)
: The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.name(Option<String>)
: The name that you specified for the Cluster.network_settings(Option<ClusterNetworkSettings>)
: Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.state(Option<ClusterState>)
: The current state of the Cluster.
- On failure, responds with
SdkError<DeleteClusterError>
Source§impl Client
impl Client
Sourcepub fn delete_event_bridge_rule_template(
&self,
) -> DeleteEventBridgeRuleTemplateFluentBuilder
pub fn delete_event_bridge_rule_template( &self, ) -> DeleteEventBridgeRuleTemplateFluentBuilder
Constructs a fluent builder for the DeleteEventBridgeRuleTemplate
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template’s identifier. Can be either be its id or current name.
- On success, responds with
DeleteEventBridgeRuleTemplateOutput
- On failure, responds with
SdkError<DeleteEventBridgeRuleTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_event_bridge_rule_template_group(
&self,
) -> DeleteEventBridgeRuleTemplateGroupFluentBuilder
pub fn delete_event_bridge_rule_template_group( &self, ) -> DeleteEventBridgeRuleTemplateGroupFluentBuilder
Constructs a fluent builder for the DeleteEventBridgeRuleTemplateGroup
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template group’s identifier. Can be either be its id or current name.
- On success, responds with
DeleteEventBridgeRuleTemplateGroupOutput
- On failure, responds with
SdkError<DeleteEventBridgeRuleTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_input(&self) -> DeleteInputFluentBuilder
pub fn delete_input(&self) -> DeleteInputFluentBuilder
Constructs a fluent builder for the DeleteInput
operation.
- The fluent builder is configurable:
input_id(impl Into<String>)
/set_input_id(Option<String>)
:
required: true
Unique ID of the input
- On success, responds with
DeleteInputOutput
- On failure, responds with
SdkError<DeleteInputError>
Source§impl Client
impl Client
Sourcepub fn delete_input_security_group(
&self,
) -> DeleteInputSecurityGroupFluentBuilder
pub fn delete_input_security_group( &self, ) -> DeleteInputSecurityGroupFluentBuilder
Constructs a fluent builder for the DeleteInputSecurityGroup
operation.
- The fluent builder is configurable:
input_security_group_id(impl Into<String>)
/set_input_security_group_id(Option<String>)
:
required: true
The Input Security Group to delete
- On success, responds with
DeleteInputSecurityGroupOutput
- On failure, responds with
SdkError<DeleteInputSecurityGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_multiplex(&self) -> DeleteMultiplexFluentBuilder
pub fn delete_multiplex(&self) -> DeleteMultiplexFluentBuilder
Constructs a fluent builder for the DeleteMultiplex
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex.
- On success, responds with
DeleteMultiplexOutput
with field(s):arn(Option<String>)
: The unique arn of the multiplex.availability_zones(Option<Vec::<String>>)
: A list of availability zones for the multiplex.destinations(Option<Vec::<MultiplexOutputDestination>>)
: A list of the multiplex output destinations.id(Option<String>)
: The unique id of the multiplex.multiplex_settings(Option<MultiplexSettings>)
: Configuration for a multiplex event.name(Option<String>)
: The name of the multiplex.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.program_count(Option<i32>)
: The number of programs in the multiplex.state(Option<MultiplexState>)
: The current state of the multiplex.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.
- On failure, responds with
SdkError<DeleteMultiplexError>
Source§impl Client
impl Client
Sourcepub fn delete_multiplex_program(&self) -> DeleteMultiplexProgramFluentBuilder
pub fn delete_multiplex_program(&self) -> DeleteMultiplexProgramFluentBuilder
Constructs a fluent builder for the DeleteMultiplexProgram
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex that the program belongs to.program_name(impl Into<String>)
/set_program_name(Option<String>)
:
required: true
The multiplex program name.
- On success, responds with
DeleteMultiplexProgramOutput
with field(s):channel_id(Option<String>)
: The MediaLive channel associated with the program.multiplex_program_settings(Option<MultiplexProgramSettings>)
: The settings for this multiplex program.packet_identifiers_map(Option<MultiplexProgramPacketIdentifiersMap>)
: The packet identifier map for this multiplex program.pipeline_details(Option<Vec::<MultiplexProgramPipelineDetail>>)
: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.program_name(Option<String>)
: The name of the multiplex program.
- On failure, responds with
SdkError<DeleteMultiplexProgramError>
Source§impl Client
impl Client
Sourcepub fn delete_network(&self) -> DeleteNetworkFluentBuilder
pub fn delete_network(&self) -> DeleteNetworkFluentBuilder
Constructs a fluent builder for the DeleteNetwork
operation.
- The fluent builder is configurable:
network_id(impl Into<String>)
/set_network_id(Option<String>)
:
required: true
The ID of the network.
- On success, responds with
DeleteNetworkOutput
with field(s):arn(Option<String>)
: The ARN of this Network. It is automatically assigned when the Network is created.associated_cluster_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringid(Option<String>)
: The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.ip_pools(Option<Vec::<IpPool>>)
: An array of IpPools in your organization’s network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.name(Option<String>)
: The name that you specified for the Network.routes(Option<Vec::<Route>>)
: An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.state(Option<NetworkState>)
: The current state of the Network. Only MediaLive Anywhere can change the state.
- On failure, responds with
SdkError<DeleteNetworkError>
Source§impl Client
impl Client
Sourcepub fn delete_node(&self) -> DeleteNodeFluentBuilder
pub fn delete_node(&self) -> DeleteNodeFluentBuilder
Constructs a fluent builder for the DeleteNode
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clusternode_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: true
The ID of the node.
- On success, responds with
DeleteNodeOutput
with field(s):arn(Option<String>)
: The ARN of the Node. It is automatically assigned when the Node is created.channel_placement_groups(Option<Vec::<String>>)
: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.cluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.connection_state(Option<NodeConnectionState>)
: The current connection state of the Node.id(Option<String>)
: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.instance_arn(Option<String>)
: The ARN of the EC2 instance hosting the Node.name(Option<String>)
: The name that you specified for the Node.node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
: Documentation update neededrole(Option<NodeRole>)
: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.state(Option<NodeState>)
: The current state of the Node.sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)
: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
- On failure, responds with
SdkError<DeleteNodeError>
Source§impl Client
impl Client
Sourcepub fn delete_reservation(&self) -> DeleteReservationFluentBuilder
pub fn delete_reservation(&self) -> DeleteReservationFluentBuilder
Constructs a fluent builder for the DeleteReservation
operation.
- The fluent builder is configurable:
reservation_id(impl Into<String>)
/set_reservation_id(Option<String>)
:
required: true
Unique reservation ID, e.g. ‘1234567’
- On success, responds with
DeleteReservationOutput
with field(s):arn(Option<String>)
: Unique reservation ARN, e.g. ‘arn:aws:medialive:us-west-2:123456789012:reservation:1234567’count(Option<i32>)
: Number of reserved resourcescurrency_code(Option<String>)
: Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. ‘USD’duration(Option<i32>)
: Lease duration, e.g. ‘12’duration_units(Option<OfferingDurationUnits>)
: Units for duration, e.g. ‘MONTHS’end(Option<String>)
: Reservation UTC end date and time in ISO-8601 format, e.g. ‘2019-03-01T00:00:00’fixed_price(Option<f64>)
: One-time charge for each reserved resource, e.g. ‘0.0’ for a NO_UPFRONT offeringname(Option<String>)
: User specified reservation nameoffering_description(Option<String>)
: Offering description, e.g. ‘HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)’offering_id(Option<String>)
: Unique offering ID, e.g. ‘87654321’offering_type(Option<OfferingType>)
: Offering type, e.g. ‘NO_UPFRONT’region(Option<String>)
: AWS region, e.g. ‘us-west-2’renewal_settings(Option<RenewalSettings>)
: Renewal settings for the reservationreservation_id(Option<String>)
: Unique reservation ID, e.g. ‘1234567’resource_specification(Option<ReservationResourceSpecification>)
: Resource configuration detailsstart(Option<String>)
: Reservation UTC start date and time in ISO-8601 format, e.g. ‘2018-03-01T00:00:00’state(Option<ReservationState>)
: Current state of reservation, e.g. ‘ACTIVE’tags(Option<HashMap::<String, String>>)
: A collection of key-value pairsusage_price(Option<f64>)
: Recurring usage charge for each reserved resource, e.g. ‘157.0’
- On failure, responds with
SdkError<DeleteReservationError>
Source§impl Client
impl Client
Sourcepub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder
pub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder
Constructs a fluent builder for the DeleteSchedule
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Id of the channel whose schedule is being deleted.
- On success, responds with
DeleteScheduleOutput
- On failure, responds with
SdkError<DeleteScheduleError>
Source§impl Client
impl Client
Sourcepub fn delete_sdi_source(&self) -> DeleteSdiSourceFluentBuilder
pub fn delete_sdi_source(&self) -> DeleteSdiSourceFluentBuilder
Constructs a fluent builder for the DeleteSdiSource
operation.
- The fluent builder is configurable:
sdi_source_id(impl Into<String>)
/set_sdi_source_id(Option<String>)
:
required: true
The ID of the SdiSource.
- On success, responds with
DeleteSdiSourceOutput
with field(s):sdi_source(Option<SdiSource>)
: Settings for the SDI source.
- On failure, responds with
SdkError<DeleteSdiSourceError>
Source§impl Client
impl Client
Sourcepub fn delete_signal_map(&self) -> DeleteSignalMapFluentBuilder
pub fn delete_signal_map(&self) -> DeleteSignalMapFluentBuilder
Constructs a fluent builder for the DeleteSignalMap
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
DeleteSignalMapOutput
- On failure, responds with
SdkError<DeleteSignalMapError>
Source§impl Client
impl Client
Constructs a fluent builder for the DeleteTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
Placeholder documentation for __stringtag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
An array of tag keys to delete
- On success, responds with
DeleteTagsOutput
- On failure, responds with
SdkError<DeleteTagsError>
Source§impl Client
impl Client
Sourcepub fn describe_account_configuration(
&self,
) -> DescribeAccountConfigurationFluentBuilder
pub fn describe_account_configuration( &self, ) -> DescribeAccountConfigurationFluentBuilder
Constructs a fluent builder for the DescribeAccountConfiguration
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeAccountConfigurationOutput
with field(s):account_configuration(Option<AccountConfiguration>)
: Placeholder documentation for AccountConfiguration
- On failure, responds with
SdkError<DescribeAccountConfigurationError>
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:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
channel ID
- On success, responds with
DescribeChannelOutput
with field(s):arn(Option<String>)
: The unique arn of the channel.cdi_input_specification(Option<CdiInputSpecification>)
: Specification of CDI inputs for this channelchannel_class(Option<ChannelClass>)
: The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(Option<Vec::<OutputDestination>>)
: A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.egress_endpoints(Option<Vec::<ChannelEgressEndpoint>>)
: The endpoints where outgoing connections initiate fromencoder_settings(Option<EncoderSettings>)
: Encoder Settingsid(Option<String>)
: The unique id of the channel.input_attachments(Option<Vec::<InputAttachment>>)
: List of input attachments for channel.input_specification(Option<InputSpecification>)
: Specification of network and file inputs for this channellog_level(Option<LogLevel>)
: The log level being written to CloudWatch Logs.maintenance(Option<MaintenanceStatus>)
: Maintenance settings for this channel.name(Option<String>)
: The name of the channel. (user-mutable)pipeline_details(Option<Vec::<PipelineDetail>>)
: Runtime details for the pipelines of a running channel.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role assumed when running the Channel.state(Option<ChannelState>)
: Placeholder documentation for ChannelStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.vpc(Option<VpcOutputSettingsDescription>)
: Settings for VPC outputanywhere_settings(Option<DescribeAnywhereSettings>)
: Anywhere settings for this channel.channel_engine_version(Option<ChannelEngineVersionResponse>)
: Requested engine version for this channel.
- On failure, responds with
SdkError<DescribeChannelError>
Source§impl Client
impl Client
Sourcepub fn describe_channel_placement_group(
&self,
) -> DescribeChannelPlacementGroupFluentBuilder
pub fn describe_channel_placement_group( &self, ) -> DescribeChannelPlacementGroupFluentBuilder
Constructs a fluent builder for the DescribeChannelPlacementGroup
operation.
- The fluent builder is configurable:
channel_placement_group_id(impl Into<String>)
/set_channel_placement_group_id(Option<String>)
:
required: true
The ID of the channel placement group.cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.
- On success, responds with
DescribeChannelPlacementGroupOutput
with field(s):arn(Option<String>)
: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.channels(Option<Vec::<String>>)
: Used in ListChannelPlacementGroupsResultcluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.id(Option<String>)
: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.name(Option<String>)
: The name that you specified for the ChannelPlacementGroup.nodes(Option<Vec::<String>>)
: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.state(Option<ChannelPlacementGroupState>)
: The current state of the ChannelPlacementGroup.
- On failure, responds with
SdkError<DescribeChannelPlacementGroupError>
Source§impl Client
impl Client
Sourcepub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
Constructs a fluent builder for the DescribeCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.
- On success, responds with
DescribeClusterOutput
with field(s):arn(Option<String>)
: The ARN of this Cluster. It is automatically assigned when the Cluster is created.channel_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringcluster_type(Option<ClusterType>)
: The hardware type for the Clusterid(Option<String>)
: The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.instance_role_arn(Option<String>)
: The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.name(Option<String>)
: The name that you specified for the Cluster.network_settings(Option<ClusterNetworkSettings>)
: Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.state(Option<ClusterState>)
: The current state of the Cluster.
- On failure, responds with
SdkError<DescribeClusterError>
Source§impl Client
impl Client
Sourcepub fn describe_input(&self) -> DescribeInputFluentBuilder
pub fn describe_input(&self) -> DescribeInputFluentBuilder
Constructs a fluent builder for the DescribeInput
operation.
- The fluent builder is configurable:
input_id(impl Into<String>)
/set_input_id(Option<String>)
:
required: true
Unique ID of the input
- On success, responds with
DescribeInputOutput
with field(s):arn(Option<String>)
: The Unique ARN of the input (generated, immutable).attached_channels(Option<Vec::<String>>)
: A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).destinations(Option<Vec::<InputDestination>>)
: A list of the destinations of the input (PUSH-type).id(Option<String>)
: The generated ID of the input (unique for user account, immutable).input_class(Option<InputClass>)
: STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.input_devices(Option<Vec::<InputDeviceSettings>>)
: Settings for the input devices.input_partner_ids(Option<Vec::<String>>)
: A list of IDs for all Inputs which are partners of this one.input_source_type(Option<InputSourceType>)
: Certain pull input sources can be dynamic, meaning that they can have their URL’s dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.media_connect_flows(Option<Vec::<MediaConnectFlow>>)
: A list of MediaConnect Flows for this input.name(Option<String>)
: The user-assigned name (This is a mutable value).role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role this input assumes during and after creation.security_groups(Option<Vec::<String>>)
: A list of IDs for all the Input Security Groups attached to the input.sources(Option<Vec::<InputSource>>)
: A list of the sources of the input (PULL-type).state(Option<InputState>)
: Placeholder documentation for InputStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.r#type(Option<InputType>)
: The different types of inputs that AWS Elemental MediaLive supports.srt_settings(Option<SrtSettings>)
: The settings associated with an SRT input.input_network_location(Option<InputNetworkLocation>)
: The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.multicast_settings(Option<MulticastSettings>)
: Multicast Input settings.smpte2110_receiver_group_settings(Option<Smpte2110ReceiverGroupSettings>)
: Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.sdi_sources(Option<Vec::<String>>)
: SDI Sources for this Input.
- On failure, responds with
SdkError<DescribeInputError>
Source§impl Client
impl Client
Sourcepub fn describe_input_device(&self) -> DescribeInputDeviceFluentBuilder
pub fn describe_input_device(&self) -> DescribeInputDeviceFluentBuilder
Constructs a fluent builder for the DescribeInputDevice
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of this input device. For example, hd-123456789abcdef.
- On success, responds with
DescribeInputDeviceOutput
with field(s):arn(Option<String>)
: The unique ARN of the input device.connection_state(Option<InputDeviceConnectionState>)
: The state of the connection between the input device and AWS.device_settings_sync_state(Option<DeviceSettingsSyncState>)
: The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.device_update_status(Option<DeviceUpdateStatus>)
: The status of software on the input device.hd_device_settings(Option<InputDeviceHdSettings>)
: Settings that describe an input device that is type HD.id(Option<String>)
: The unique ID of the input device.mac_address(Option<String>)
: The network MAC address of the input device.name(Option<String>)
: A name that you specify for the input device.network_settings(Option<InputDeviceNetworkSettings>)
: The network settings for the input device.serial_number(Option<String>)
: The unique serial number of the input device.r#type(Option<InputDeviceType>)
: The type of the input device.uhd_device_settings(Option<InputDeviceUhdSettings>)
: Settings that describe an input device that is type UHD.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.availability_zone(Option<String>)
: The Availability Zone associated with this input device.medialive_input_arns(Option<Vec::<String>>)
: An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.output_type(Option<InputDeviceOutputType>)
: The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.
- On failure, responds with
SdkError<DescribeInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn describe_input_device_thumbnail(
&self,
) -> DescribeInputDeviceThumbnailFluentBuilder
pub fn describe_input_device_thumbnail( &self, ) -> DescribeInputDeviceThumbnailFluentBuilder
Constructs a fluent builder for the DescribeInputDeviceThumbnail
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of this input device. For example, hd-123456789abcdef.accept(AcceptHeader)
/set_accept(Option<AcceptHeader>)
:
required: true
The HTTP Accept header. Indicates the requested type for the thumbnail.
- On success, responds with
DescribeInputDeviceThumbnailOutput
with field(s):body(ByteStream)
: The binary data for the thumbnail that the Link device has most recently sent to MediaLive.content_type(Option<ContentType>)
: Specifies the media type of the thumbnail.content_length(Option<i64>)
: The length of the content.e_tag(Option<String>)
: The unique, cacheable version of this thumbnail.last_modified(Option<DateTime>)
: The date and time the thumbnail was last updated at the device.
- On failure, responds with
SdkError<DescribeInputDeviceThumbnailError>
Source§impl Client
impl Client
Sourcepub fn describe_input_security_group(
&self,
) -> DescribeInputSecurityGroupFluentBuilder
pub fn describe_input_security_group( &self, ) -> DescribeInputSecurityGroupFluentBuilder
Constructs a fluent builder for the DescribeInputSecurityGroup
operation.
- The fluent builder is configurable:
input_security_group_id(impl Into<String>)
/set_input_security_group_id(Option<String>)
:
required: true
The id of the Input Security Group to describe
- On success, responds with
DescribeInputSecurityGroupOutput
with field(s):arn(Option<String>)
: Unique ARN of Input Security Groupid(Option<String>)
: The Id of the Input Security Groupinputs(Option<Vec::<String>>)
: The list of inputs currently using this Input Security Group.state(Option<InputSecurityGroupState>)
: The current state of the Input Security Group.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.whitelist_rules(Option<Vec::<InputWhitelistRule>>)
: Whitelist rules and their sync status
- On failure, responds with
SdkError<DescribeInputSecurityGroupError>
Source§impl Client
impl Client
Sourcepub fn describe_multiplex(&self) -> DescribeMultiplexFluentBuilder
pub fn describe_multiplex(&self) -> DescribeMultiplexFluentBuilder
Constructs a fluent builder for the DescribeMultiplex
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex.
- On success, responds with
DescribeMultiplexOutput
with field(s):arn(Option<String>)
: The unique arn of the multiplex.availability_zones(Option<Vec::<String>>)
: A list of availability zones for the multiplex.destinations(Option<Vec::<MultiplexOutputDestination>>)
: A list of the multiplex output destinations.id(Option<String>)
: The unique id of the multiplex.multiplex_settings(Option<MultiplexSettings>)
: Configuration for a multiplex event.name(Option<String>)
: The name of the multiplex.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.program_count(Option<i32>)
: The number of programs in the multiplex.state(Option<MultiplexState>)
: The current state of the multiplex.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.
- On failure, responds with
SdkError<DescribeMultiplexError>
Source§impl Client
impl Client
Sourcepub fn describe_multiplex_program(
&self,
) -> DescribeMultiplexProgramFluentBuilder
pub fn describe_multiplex_program( &self, ) -> DescribeMultiplexProgramFluentBuilder
Constructs a fluent builder for the DescribeMultiplexProgram
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex that the program belongs to.program_name(impl Into<String>)
/set_program_name(Option<String>)
:
required: true
The name of the program.
- On success, responds with
DescribeMultiplexProgramOutput
with field(s):channel_id(Option<String>)
: The MediaLive channel associated with the program.multiplex_program_settings(Option<MultiplexProgramSettings>)
: The settings for this multiplex program.packet_identifiers_map(Option<MultiplexProgramPacketIdentifiersMap>)
: The packet identifier map for this multiplex program.pipeline_details(Option<Vec::<MultiplexProgramPipelineDetail>>)
: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.program_name(Option<String>)
: The name of the multiplex program.
- On failure, responds with
SdkError<DescribeMultiplexProgramError>
Source§impl Client
impl Client
Sourcepub fn describe_network(&self) -> DescribeNetworkFluentBuilder
pub fn describe_network(&self) -> DescribeNetworkFluentBuilder
Constructs a fluent builder for the DescribeNetwork
operation.
- The fluent builder is configurable:
network_id(impl Into<String>)
/set_network_id(Option<String>)
:
required: true
The ID of the network.
- On success, responds with
DescribeNetworkOutput
with field(s):arn(Option<String>)
: The ARN of this Network. It is automatically assigned when the Network is created.associated_cluster_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringid(Option<String>)
: The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.ip_pools(Option<Vec::<IpPool>>)
: An array of IpPools in your organization’s network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.name(Option<String>)
: The name that you specified for the Network.routes(Option<Vec::<Route>>)
: An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.state(Option<NetworkState>)
: The current state of the Network. Only MediaLive Anywhere can change the state.
- On failure, responds with
SdkError<DescribeNetworkError>
Source§impl Client
impl Client
Sourcepub fn describe_node(&self) -> DescribeNodeFluentBuilder
pub fn describe_node(&self) -> DescribeNodeFluentBuilder
Constructs a fluent builder for the DescribeNode
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clusternode_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: true
The ID of the node.
- On success, responds with
DescribeNodeOutput
with field(s):arn(Option<String>)
: The ARN of the Node. It is automatically assigned when the Node is created.channel_placement_groups(Option<Vec::<String>>)
: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.cluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.connection_state(Option<NodeConnectionState>)
: The current connection state of the Node.id(Option<String>)
: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.instance_arn(Option<String>)
: The ARN of the EC2 instance hosting the Node.name(Option<String>)
: The name that you specified for the Node.node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
: Documentation update neededrole(Option<NodeRole>)
: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.state(Option<NodeState>)
: The current state of the Node.sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)
: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
- On failure, responds with
SdkError<DescribeNodeError>
Source§impl Client
impl Client
Sourcepub fn describe_offering(&self) -> DescribeOfferingFluentBuilder
pub fn describe_offering(&self) -> DescribeOfferingFluentBuilder
Constructs a fluent builder for the DescribeOffering
operation.
- The fluent builder is configurable:
offering_id(impl Into<String>)
/set_offering_id(Option<String>)
:
required: true
Unique offering ID, e.g. ‘87654321’
- On success, responds with
DescribeOfferingOutput
with field(s):arn(Option<String>)
: Unique offering ARN, e.g. ‘arn:aws:medialive:us-west-2:123456789012:offering:87654321’currency_code(Option<String>)
: Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. ‘USD’duration(Option<i32>)
: Lease duration, e.g. ‘12’duration_units(Option<OfferingDurationUnits>)
: Units for duration, e.g. ‘MONTHS’fixed_price(Option<f64>)
: One-time charge for each reserved resource, e.g. ‘0.0’ for a NO_UPFRONT offeringoffering_description(Option<String>)
: Offering description, e.g. ‘HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)’offering_id(Option<String>)
: Unique offering ID, e.g. ‘87654321’offering_type(Option<OfferingType>)
: Offering type, e.g. ‘NO_UPFRONT’region(Option<String>)
: AWS region, e.g. ‘us-west-2’resource_specification(Option<ReservationResourceSpecification>)
: Resource configuration detailsusage_price(Option<f64>)
: Recurring usage charge for each reserved resource, e.g. ‘157.0’
- On failure, responds with
SdkError<DescribeOfferingError>
Source§impl Client
impl Client
Sourcepub fn describe_reservation(&self) -> DescribeReservationFluentBuilder
pub fn describe_reservation(&self) -> DescribeReservationFluentBuilder
Constructs a fluent builder for the DescribeReservation
operation.
- The fluent builder is configurable:
reservation_id(impl Into<String>)
/set_reservation_id(Option<String>)
:
required: true
Unique reservation ID, e.g. ‘1234567’
- On success, responds with
DescribeReservationOutput
with field(s):arn(Option<String>)
: Unique reservation ARN, e.g. ‘arn:aws:medialive:us-west-2:123456789012:reservation:1234567’count(Option<i32>)
: Number of reserved resourcescurrency_code(Option<String>)
: Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. ‘USD’duration(Option<i32>)
: Lease duration, e.g. ‘12’duration_units(Option<OfferingDurationUnits>)
: Units for duration, e.g. ‘MONTHS’end(Option<String>)
: Reservation UTC end date and time in ISO-8601 format, e.g. ‘2019-03-01T00:00:00’fixed_price(Option<f64>)
: One-time charge for each reserved resource, e.g. ‘0.0’ for a NO_UPFRONT offeringname(Option<String>)
: User specified reservation nameoffering_description(Option<String>)
: Offering description, e.g. ‘HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)’offering_id(Option<String>)
: Unique offering ID, e.g. ‘87654321’offering_type(Option<OfferingType>)
: Offering type, e.g. ‘NO_UPFRONT’region(Option<String>)
: AWS region, e.g. ‘us-west-2’renewal_settings(Option<RenewalSettings>)
: Renewal settings for the reservationreservation_id(Option<String>)
: Unique reservation ID, e.g. ‘1234567’resource_specification(Option<ReservationResourceSpecification>)
: Resource configuration detailsstart(Option<String>)
: Reservation UTC start date and time in ISO-8601 format, e.g. ‘2018-03-01T00:00:00’state(Option<ReservationState>)
: Current state of reservation, e.g. ‘ACTIVE’tags(Option<HashMap::<String, String>>)
: A collection of key-value pairsusage_price(Option<f64>)
: Recurring usage charge for each reserved resource, e.g. ‘157.0’
- On failure, responds with
SdkError<DescribeReservationError>
Source§impl Client
impl Client
Sourcepub fn describe_schedule(&self) -> DescribeScheduleFluentBuilder
pub fn describe_schedule(&self) -> DescribeScheduleFluentBuilder
Constructs a fluent builder for the DescribeSchedule
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Id of the channel whose schedule is being updated.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __string
- On success, responds with
DescribeScheduleOutput
with field(s):next_token(Option<String>)
: The next token; for use in pagination.schedule_actions(Option<Vec::<ScheduleAction>>)
: The list of actions in the schedule.
- On failure, responds with
SdkError<DescribeScheduleError>
Source§impl Client
impl Client
Sourcepub fn describe_sdi_source(&self) -> DescribeSdiSourceFluentBuilder
pub fn describe_sdi_source(&self) -> DescribeSdiSourceFluentBuilder
Constructs a fluent builder for the DescribeSdiSource
operation.
- The fluent builder is configurable:
sdi_source_id(impl Into<String>)
/set_sdi_source_id(Option<String>)
:
required: true
Get details about an SdiSource.
- On success, responds with
DescribeSdiSourceOutput
with field(s):sdi_source(Option<SdiSource>)
: Settings for the SDI source.
- On failure, responds with
SdkError<DescribeSdiSourceError>
Source§impl Client
impl Client
Sourcepub fn describe_thumbnails(&self) -> DescribeThumbnailsFluentBuilder
pub fn describe_thumbnails(&self) -> DescribeThumbnailsFluentBuilder
Constructs a fluent builder for the DescribeThumbnails
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Unique ID of the channelpipeline_id(impl Into<String>)
/set_pipeline_id(Option<String>)
:
required: true
Pipeline ID (“0” or “1”)thumbnail_type(impl Into<String>)
/set_thumbnail_type(Option<String>)
:
required: true
thumbnail type
- On success, responds with
DescribeThumbnailsOutput
with field(s):thumbnail_details(Option<Vec::<ThumbnailDetail>>)
: Placeholder documentation for __listOfThumbnailDetail
- On failure, responds with
SdkError<DescribeThumbnailsError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_watch_alarm_template(
&self,
) -> GetCloudWatchAlarmTemplateFluentBuilder
pub fn get_cloud_watch_alarm_template( &self, ) -> GetCloudWatchAlarmTemplateFluentBuilder
Constructs a fluent builder for the GetCloudWatchAlarmTemplate
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template’s identifier. Can be either be its id or current name.
- On success, responds with
GetCloudWatchAlarmTemplateOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template’s ARN (Amazon Resource Name)comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)
: The comparison operator used to compare the specified statistic and the threshold.created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601datapoints_to_alarm(Option<i32>)
: The number of datapoints within the evaluation period that must be breaching to trigger the alarm.description(Option<String>)
: A resource’s optional description.evaluation_periods(Option<i32>)
: The number of periods over which data is compared to the specified threshold.group_id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: A cloudwatch alarm template’s id. AWS provided templates have ids that start withaws-
metric_name(Option<String>)
: The name of the metric associated with the alarm. Must be compatible with targetResourceType.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.period(Option<i32>)
: The period, in seconds, over which the specified statistic is applied.statistic(Option<CloudWatchAlarmTemplateStatistic>)
: The statistic to apply to the alarm’s metric data.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)
: The resource type this template should dynamically generate cloudwatch metric alarms for.threshold(Option<f64>)
: The threshold value to compare with the specified statistic.treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)
: Specifies how missing data points are treated when evaluating the alarm’s condition.
- On failure, responds with
SdkError<GetCloudWatchAlarmTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_watch_alarm_template_group(
&self,
) -> GetCloudWatchAlarmTemplateGroupFluentBuilder
pub fn get_cloud_watch_alarm_template_group( &self, ) -> GetCloudWatchAlarmTemplateGroupFluentBuilder
Constructs a fluent builder for the GetCloudWatchAlarmTemplateGroup
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.
- On success, responds with
GetCloudWatchAlarmTemplateGroupOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<GetCloudWatchAlarmTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn get_event_bridge_rule_template(
&self,
) -> GetEventBridgeRuleTemplateFluentBuilder
pub fn get_event_bridge_rule_template( &self, ) -> GetEventBridgeRuleTemplateFluentBuilder
Constructs a fluent builder for the GetEventBridgeRuleTemplate
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template’s identifier. Can be either be its id or current name.
- On success, responds with
GetEventBridgeRuleTemplateOutput
with field(s):arn(Option<String>)
: An eventbridge rule template’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.event_targets(Option<Vec::<EventBridgeRuleTemplateTarget>>)
: Placeholder documentation for __listOfEventBridgeRuleTemplateTargetevent_type(Option<EventBridgeRuleTemplateEventType>)
: The type of event to match with the rule.group_id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: An eventbridge rule template’s id. AWS provided templates have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<GetEventBridgeRuleTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_event_bridge_rule_template_group(
&self,
) -> GetEventBridgeRuleTemplateGroupFluentBuilder
pub fn get_event_bridge_rule_template_group( &self, ) -> GetEventBridgeRuleTemplateGroupFluentBuilder
Constructs a fluent builder for the GetEventBridgeRuleTemplateGroup
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template group’s identifier. Can be either be its id or current name.
- On success, responds with
GetEventBridgeRuleTemplateGroupOutput
with field(s):arn(Option<String>)
: An eventbridge rule template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<GetEventBridgeRuleTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn get_signal_map(&self) -> GetSignalMapFluentBuilder
pub fn get_signal_map(&self) -> GetSignalMapFluentBuilder
Constructs a fluent builder for the GetSignalMap
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
GetSignalMapOutput
with field(s):arn(Option<String>)
: A signal map’s ARN (Amazon Resource Name)cloud_watch_alarm_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.discovery_entry_point_arn(Option<String>)
: A top-level supported AWS resource ARN to discovery a signal map from.error_message(Option<String>)
: Error message associated with a failed creation or failed update attempt of a signal map.event_bridge_rule_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097failed_media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an incomplete AWS media workflow as a graph.id(Option<String>)
: A signal map’s id.last_discovered_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601last_successful_monitor_deployment(Option<SuccessfulMonitorDeployment>)
: Represents the latest successful monitor deployment of a signal map.media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an AWS media workflow as a graph.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601monitor_changes_pending_deployment(Option<bool>)
: If true, there are pending monitor changes for this signal map that can be deployed.monitor_deployment(Option<MonitorDeployment>)
: Represents the latest monitor deployment of a signal map.name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.status(Option<SignalMapStatus>)
: A signal map’s current status which is dependent on its lifecycle actions or associated jobs.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<GetSignalMapError>
Source§impl Client
impl Client
Sourcepub fn list_channel_placement_groups(
&self,
) -> ListChannelPlacementGroupsFluentBuilder
pub fn list_channel_placement_groups( &self, ) -> ListChannelPlacementGroupsFluentBuilder
Constructs a fluent builder for the ListChannelPlacementGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clustermax_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListChannelPlacementGroupsOutput
with field(s):channel_placement_groups(Option<Vec::<DescribeChannelPlacementGroupSummary>>)
: An array of ChannelPlacementGroups that exist in the Cluster.next_token(Option<String>)
: Token for the next result.
- On failure, responds with
SdkError<ListChannelPlacementGroupsError>
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
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __string
- On success, responds with
ListChannelsOutput
with field(s):channels(Option<Vec::<ChannelSummary>>)
: Placeholder documentation for __listOfChannelSummarynext_token(Option<String>)
: Placeholder documentation for __string
- On failure, responds with
SdkError<ListChannelsError>
Source§impl Client
impl Client
Sourcepub fn list_cloud_watch_alarm_template_groups(
&self,
) -> ListCloudWatchAlarmTemplateGroupsFluentBuilder
pub fn list_cloud_watch_alarm_template_groups( &self, ) -> ListCloudWatchAlarmTemplateGroupsFluentBuilder
Constructs a fluent builder for the ListCloudWatchAlarmTemplateGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to retrieve the next set of results in paginated list responses.scope(impl Into<String>)
/set_scope(Option<String>)
:
required: false
Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.signal_map_identifier(impl Into<String>)
/set_signal_map_identifier(Option<String>)
:
required: false
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
ListCloudWatchAlarmTemplateGroupsOutput
with field(s):cloud_watch_alarm_template_groups(Option<Vec::<CloudWatchAlarmTemplateGroupSummary>>)
: Placeholder documentation for __listOfCloudWatchAlarmTemplateGroupSummarynext_token(Option<String>)
: A token used to retrieve the next set of results in paginated list responses.
- On failure, responds with
SdkError<ListCloudWatchAlarmTemplateGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_cloud_watch_alarm_templates(
&self,
) -> ListCloudWatchAlarmTemplatesFluentBuilder
pub fn list_cloud_watch_alarm_templates( &self, ) -> ListCloudWatchAlarmTemplatesFluentBuilder
Constructs a fluent builder for the ListCloudWatchAlarmTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: false
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to retrieve the next set of results in paginated list responses.scope(impl Into<String>)
/set_scope(Option<String>)
:
required: false
Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.signal_map_identifier(impl Into<String>)
/set_signal_map_identifier(Option<String>)
:
required: false
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
ListCloudWatchAlarmTemplatesOutput
with field(s):cloud_watch_alarm_templates(Option<Vec::<CloudWatchAlarmTemplateSummary>>)
: Placeholder documentation for __listOfCloudWatchAlarmTemplateSummarynext_token(Option<String>)
: A token used to retrieve the next set of results in paginated list responses.
- On failure, responds with
SdkError<ListCloudWatchAlarmTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_clusters(&self) -> ListClustersFluentBuilder
pub fn list_clusters(&self) -> ListClustersFluentBuilder
Constructs a fluent builder for the ListClusters
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 items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListClustersOutput
with field(s):clusters(Option<Vec::<DescribeClusterSummary>>)
: A list of the Clusters that exist in your AWS account.next_token(Option<String>)
: Token for the next result.
- On failure, responds with
SdkError<ListClustersError>
Source§impl Client
impl Client
Sourcepub fn list_event_bridge_rule_template_groups(
&self,
) -> ListEventBridgeRuleTemplateGroupsFluentBuilder
pub fn list_event_bridge_rule_template_groups( &self, ) -> ListEventBridgeRuleTemplateGroupsFluentBuilder
Constructs a fluent builder for the ListEventBridgeRuleTemplateGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to retrieve the next set of results in paginated list responses.signal_map_identifier(impl Into<String>)
/set_signal_map_identifier(Option<String>)
:
required: false
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
ListEventBridgeRuleTemplateGroupsOutput
with field(s):event_bridge_rule_template_groups(Option<Vec::<EventBridgeRuleTemplateGroupSummary>>)
: Placeholder documentation for __listOfEventBridgeRuleTemplateGroupSummarynext_token(Option<String>)
: A token used to retrieve the next set of results in paginated list responses.
- On failure, responds with
SdkError<ListEventBridgeRuleTemplateGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_event_bridge_rule_templates(
&self,
) -> ListEventBridgeRuleTemplatesFluentBuilder
pub fn list_event_bridge_rule_templates( &self, ) -> ListEventBridgeRuleTemplatesFluentBuilder
Constructs a fluent builder for the ListEventBridgeRuleTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: false
An eventbridge rule template group’s identifier. Can be either be its id or current name.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to retrieve the next set of results in paginated list responses.signal_map_identifier(impl Into<String>)
/set_signal_map_identifier(Option<String>)
:
required: false
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
ListEventBridgeRuleTemplatesOutput
with field(s):event_bridge_rule_templates(Option<Vec::<EventBridgeRuleTemplateSummary>>)
: Placeholder documentation for __listOfEventBridgeRuleTemplateSummarynext_token(Option<String>)
: A token used to retrieve the next set of results in paginated list responses.
- On failure, responds with
SdkError<ListEventBridgeRuleTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_input_device_transfers(
&self,
) -> ListInputDeviceTransfersFluentBuilder
pub fn list_input_device_transfers( &self, ) -> ListInputDeviceTransfersFluentBuilder
Constructs a fluent builder for the ListInputDeviceTransfers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __stringtransfer_type(impl Into<String>)
/set_transfer_type(Option<String>)
:
required: true
Placeholder documentation for __string
- On success, responds with
ListInputDeviceTransfersOutput
with field(s):input_device_transfers(Option<Vec::<TransferringInputDeviceSummary>>)
: The list of devices that you are transferring or are being transferred to you.next_token(Option<String>)
: A token to get additional list results.
- On failure, responds with
SdkError<ListInputDeviceTransfersError>
Source§impl Client
impl Client
Sourcepub fn list_input_devices(&self) -> ListInputDevicesFluentBuilder
pub fn list_input_devices(&self) -> ListInputDevicesFluentBuilder
Constructs a fluent builder for the ListInputDevices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __string
- On success, responds with
ListInputDevicesOutput
with field(s):input_devices(Option<Vec::<InputDeviceSummary>>)
: The list of input devices.next_token(Option<String>)
: A token to get additional list results.
- On failure, responds with
SdkError<ListInputDevicesError>
Source§impl Client
impl Client
Sourcepub fn list_input_security_groups(&self) -> ListInputSecurityGroupsFluentBuilder
pub fn list_input_security_groups(&self) -> ListInputSecurityGroupsFluentBuilder
Constructs a fluent builder for the ListInputSecurityGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __string
- On success, responds with
ListInputSecurityGroupsOutput
with field(s):input_security_groups(Option<Vec::<InputSecurityGroup>>)
: List of input security groupsnext_token(Option<String>)
: Placeholder documentation for __string
- On failure, responds with
SdkError<ListInputSecurityGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_inputs(&self) -> ListInputsFluentBuilder
pub fn list_inputs(&self) -> ListInputsFluentBuilder
Constructs a fluent builder for the ListInputs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __string
- On success, responds with
ListInputsOutput
with field(s):inputs(Option<Vec::<Input>>)
: Placeholder documentation for __listOfInputnext_token(Option<String>)
: Placeholder documentation for __string
- On failure, responds with
SdkError<ListInputsError>
Source§impl Client
impl Client
Sourcepub fn list_multiplex_programs(&self) -> ListMultiplexProgramsFluentBuilder
pub fn list_multiplex_programs(&self) -> ListMultiplexProgramsFluentBuilder
Constructs a fluent builder for the ListMultiplexPrograms
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 items to return.multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex that the programs belong to.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListMultiplexProgramsOutput
with field(s):multiplex_programs(Option<Vec::<MultiplexProgramSummary>>)
: List of multiplex programs.next_token(Option<String>)
: Token for the next ListMultiplexProgram request.
- On failure, responds with
SdkError<ListMultiplexProgramsError>
Source§impl Client
impl Client
Sourcepub fn list_multiplexes(&self) -> ListMultiplexesFluentBuilder
pub fn list_multiplexes(&self) -> ListMultiplexesFluentBuilder
Constructs a fluent builder for the ListMultiplexes
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 items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListMultiplexesOutput
with field(s):multiplexes(Option<Vec::<MultiplexSummary>>)
: List of multiplexes.next_token(Option<String>)
: Token for the next ListMultiplexes request.
- On failure, responds with
SdkError<ListMultiplexesError>
Source§impl Client
impl Client
Sourcepub fn list_networks(&self) -> ListNetworksFluentBuilder
pub fn list_networks(&self) -> ListNetworksFluentBuilder
Constructs a fluent builder for the ListNetworks
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 items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListNetworksOutput
with field(s):networks(Option<Vec::<DescribeNetworkSummary>>)
: An array of networks that you have created.next_token(Option<String>)
: Token for the next ListNetworks request.
- On failure, responds with
SdkError<ListNetworksError>
Source§impl Client
impl Client
Sourcepub fn list_nodes(&self) -> ListNodesFluentBuilder
pub fn list_nodes(&self) -> ListNodesFluentBuilder
Constructs a fluent builder for the ListNodes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clustermax_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListNodesOutput
with field(s):next_token(Option<String>)
: Token for the next result.nodes(Option<Vec::<DescribeNodeSummary>>)
: An array of Nodes that exist in the Cluster.
- On failure, responds with
SdkError<ListNodesError>
Source§impl Client
impl Client
Sourcepub fn list_offerings(&self) -> ListOfferingsFluentBuilder
pub fn list_offerings(&self) -> ListOfferingsFluentBuilder
Constructs a fluent builder for the ListOfferings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_class(impl Into<String>)
/set_channel_class(Option<String>)
:
required: false
Filter by channel class, ‘STANDARD’ or ‘SINGLE_PIPELINE’channel_configuration(impl Into<String>)
/set_channel_configuration(Option<String>)
:
required: false
Filter to offerings that match the configuration of an existing channel, e.g. ‘2345678’ (a channel ID)codec(impl Into<String>)
/set_codec(Option<String>)
:
required: false
Filter by codec, ‘AVC’, ‘HEVC’, ‘MPEG2’, ‘AUDIO’, ‘LINK’, or ‘AV1’duration(impl Into<String>)
/set_duration(Option<String>)
:
required: false
Filter by offering duration, e.g. ‘12’max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsmaximum_bitrate(impl Into<String>)
/set_maximum_bitrate(Option<String>)
:
required: false
Filter by bitrate, ‘MAX_10_MBPS’, ‘MAX_20_MBPS’, or ‘MAX_50_MBPS’maximum_framerate(impl Into<String>)
/set_maximum_framerate(Option<String>)
:
required: false
Filter by framerate, ‘MAX_30_FPS’ or ‘MAX_60_FPS’next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __stringresolution(impl Into<String>)
/set_resolution(Option<String>)
:
required: false
Filter by resolution, ‘SD’, ‘HD’, ‘FHD’, or ‘UHD’resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: false
Filter by resource type, ‘INPUT’, ‘OUTPUT’, ‘MULTIPLEX’, or ‘CHANNEL’special_feature(impl Into<String>)
/set_special_feature(Option<String>)
:
required: false
Filter by special feature, ‘ADVANCED_AUDIO’ or ‘AUDIO_NORMALIZATION’video_quality(impl Into<String>)
/set_video_quality(Option<String>)
:
required: false
Filter by video quality, ‘STANDARD’, ‘ENHANCED’, or ‘PREMIUM’
- On success, responds with
ListOfferingsOutput
with field(s):next_token(Option<String>)
: Token to retrieve the next page of resultsofferings(Option<Vec::<Offering>>)
: List of offerings
- On failure, responds with
SdkError<ListOfferingsError>
Source§impl Client
impl Client
Sourcepub fn list_reservations(&self) -> ListReservationsFluentBuilder
pub fn list_reservations(&self) -> ListReservationsFluentBuilder
Constructs a fluent builder for the ListReservations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
channel_class(impl Into<String>)
/set_channel_class(Option<String>)
:
required: false
Filter by channel class, ‘STANDARD’ or ‘SINGLE_PIPELINE’codec(impl Into<String>)
/set_codec(Option<String>)
:
required: false
Filter by codec, ‘AVC’, ‘HEVC’, ‘MPEG2’, ‘AUDIO’, ‘LINK’, or ‘AV1’max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsmaximum_bitrate(impl Into<String>)
/set_maximum_bitrate(Option<String>)
:
required: false
Filter by bitrate, ‘MAX_10_MBPS’, ‘MAX_20_MBPS’, or ‘MAX_50_MBPS’maximum_framerate(impl Into<String>)
/set_maximum_framerate(Option<String>)
:
required: false
Filter by framerate, ‘MAX_30_FPS’ or ‘MAX_60_FPS’next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Placeholder documentation for __stringresolution(impl Into<String>)
/set_resolution(Option<String>)
:
required: false
Filter by resolution, ‘SD’, ‘HD’, ‘FHD’, or ‘UHD’resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: false
Filter by resource type, ‘INPUT’, ‘OUTPUT’, ‘MULTIPLEX’, or ‘CHANNEL’special_feature(impl Into<String>)
/set_special_feature(Option<String>)
:
required: false
Filter by special feature, ‘ADVANCED_AUDIO’ or ‘AUDIO_NORMALIZATION’video_quality(impl Into<String>)
/set_video_quality(Option<String>)
:
required: false
Filter by video quality, ‘STANDARD’, ‘ENHANCED’, or ‘PREMIUM’
- On success, responds with
ListReservationsOutput
with field(s):next_token(Option<String>)
: Token to retrieve the next page of resultsreservations(Option<Vec::<Reservation>>)
: List of reservations
- On failure, responds with
SdkError<ListReservationsError>
Source§impl Client
impl Client
Sourcepub fn list_sdi_sources(&self) -> ListSdiSourcesFluentBuilder
pub fn list_sdi_sources(&self) -> ListSdiSourcesFluentBuilder
Constructs a fluent builder for the ListSdiSources
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 items to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token to retrieve the next page of results.
- On success, responds with
ListSdiSourcesOutput
with field(s):next_token(Option<String>)
: Placeholder documentation for __stringsdi_sources(Option<Vec::<SdiSourceSummary>>)
: Placeholder documentation for __listOfSdiSourceSummary
- On failure, responds with
SdkError<ListSdiSourcesError>
Source§impl Client
impl Client
Sourcepub fn list_signal_maps(&self) -> ListSignalMapsFluentBuilder
pub fn list_signal_maps(&self) -> ListSignalMapsFluentBuilder
Constructs a fluent builder for the ListSignalMaps
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cloud_watch_alarm_template_group_identifier(impl Into<String>)
/set_cloud_watch_alarm_template_group_identifier(Option<String>)
:
required: false
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.event_bridge_rule_template_group_identifier(impl Into<String>)
/set_event_bridge_rule_template_group_identifier(Option<String>)
:
required: false
An eventbridge rule template group’s identifier. Can be either be its id or current name.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Placeholder documentation for MaxResultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
A token used to retrieve the next set of results in paginated list responses.
- On success, responds with
ListSignalMapsOutput
with field(s):next_token(Option<String>)
: A token used to retrieve the next set of results in paginated list responses.signal_maps(Option<Vec::<SignalMapSummary>>)
: Placeholder documentation for __listOfSignalMapSummary
- On failure, responds with
SdkError<ListSignalMapsError>
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
Placeholder documentation for __string
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
: Placeholder documentation for Tags
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_versions(&self) -> ListVersionsFluentBuilder
pub fn list_versions(&self) -> ListVersionsFluentBuilder
Constructs a fluent builder for the ListVersions
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListVersionsOutput
with field(s):versions(Option<Vec::<ChannelEngineVersionResponse>>)
: List of engine versions that are available for this AWS account.
- On failure, responds with
SdkError<ListVersionsError>
Source§impl Client
impl Client
Sourcepub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder
pub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder
Constructs a fluent builder for the PurchaseOffering
operation.
- The fluent builder is configurable:
count(i32)
/set_count(Option<i32>)
:
required: true
Number of resourcesname(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name for the new reservationoffering_id(impl Into<String>)
/set_offering_id(Option<String>)
:
required: true
Offering to purchase, e.g. ‘87654321’renewal_settings(RenewalSettings)
/set_renewal_settings(Option<RenewalSettings>)
:
required: false
Renewal settings for the reservationrequest_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: false
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.start(impl Into<String>)
/set_start(Option<String>)
:
required: false
Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs
- On success, responds with
PurchaseOfferingOutput
with field(s):reservation(Option<Reservation>)
: Reserved resources available to use
- On failure, responds with
SdkError<PurchaseOfferingError>
Source§impl Client
impl Client
Sourcepub fn reboot_input_device(&self) -> RebootInputDeviceFluentBuilder
pub fn reboot_input_device(&self) -> RebootInputDeviceFluentBuilder
Constructs a fluent builder for the RebootInputDevice
operation.
- The fluent builder is configurable:
force(RebootInputDeviceForce)
/set_force(Option<RebootInputDeviceForce>)
:
required: false
Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to reboot. For example, hd-123456789abcdef.
- On success, responds with
RebootInputDeviceOutput
- On failure, responds with
SdkError<RebootInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn reject_input_device_transfer(
&self,
) -> RejectInputDeviceTransferFluentBuilder
pub fn reject_input_device_transfer( &self, ) -> RejectInputDeviceTransferFluentBuilder
Constructs a fluent builder for the RejectInputDeviceTransfer
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to reject. For example, hd-123456789abcdef.
- On success, responds with
RejectInputDeviceTransferOutput
- On failure, responds with
SdkError<RejectInputDeviceTransferError>
Source§impl Client
impl Client
Sourcepub fn restart_channel_pipelines(&self) -> RestartChannelPipelinesFluentBuilder
pub fn restart_channel_pipelines(&self) -> RestartChannelPipelinesFluentBuilder
Constructs a fluent builder for the RestartChannelPipelines
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
ID of channelpipeline_ids(ChannelPipelineIdToRestart)
/set_pipeline_ids(Option<Vec::<ChannelPipelineIdToRestart>>)
:
required: false
An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1.
- On success, responds with
RestartChannelPipelinesOutput
with field(s):arn(Option<String>)
: The unique arn of the channel.cdi_input_specification(Option<CdiInputSpecification>)
: Specification of CDI inputs for this channelchannel_class(Option<ChannelClass>)
: The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(Option<Vec::<OutputDestination>>)
: A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.egress_endpoints(Option<Vec::<ChannelEgressEndpoint>>)
: The endpoints where outgoing connections initiate fromencoder_settings(Option<EncoderSettings>)
: Encoder Settingsid(Option<String>)
: The unique id of the channel.input_attachments(Option<Vec::<InputAttachment>>)
: List of input attachments for channel.input_specification(Option<InputSpecification>)
: Specification of network and file inputs for this channellog_level(Option<LogLevel>)
: The log level being written to CloudWatch Logs.maintenance(Option<MaintenanceStatus>)
: Maintenance settings for this channel.maintenance_status(Option<String>)
: The time in milliseconds by when the PVRE restart must occur.name(Option<String>)
: The name of the channel. (user-mutable)pipeline_details(Option<Vec::<PipelineDetail>>)
: Runtime details for the pipelines of a running channel.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role assumed when running the Channel.state(Option<ChannelState>)
: Placeholder documentation for ChannelStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.vpc(Option<VpcOutputSettingsDescription>)
: Settings for VPC outputanywhere_settings(Option<DescribeAnywhereSettings>)
: Anywhere settings for this channel.channel_engine_version(Option<ChannelEngineVersionResponse>)
: Requested engine version for this channel.
- On failure, responds with
SdkError<RestartChannelPipelinesError>
Source§impl Client
impl Client
Sourcepub fn start_channel(&self) -> StartChannelFluentBuilder
pub fn start_channel(&self) -> StartChannelFluentBuilder
Constructs a fluent builder for the StartChannel
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
A request to start a channel
- On success, responds with
StartChannelOutput
with field(s):arn(Option<String>)
: The unique arn of the channel.cdi_input_specification(Option<CdiInputSpecification>)
: Specification of CDI inputs for this channelchannel_class(Option<ChannelClass>)
: The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(Option<Vec::<OutputDestination>>)
: A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.egress_endpoints(Option<Vec::<ChannelEgressEndpoint>>)
: The endpoints where outgoing connections initiate fromencoder_settings(Option<EncoderSettings>)
: Encoder Settingsid(Option<String>)
: The unique id of the channel.input_attachments(Option<Vec::<InputAttachment>>)
: List of input attachments for channel.input_specification(Option<InputSpecification>)
: Specification of network and file inputs for this channellog_level(Option<LogLevel>)
: The log level being written to CloudWatch Logs.maintenance(Option<MaintenanceStatus>)
: Maintenance settings for this channel.name(Option<String>)
: The name of the channel. (user-mutable)pipeline_details(Option<Vec::<PipelineDetail>>)
: Runtime details for the pipelines of a running channel.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role assumed when running the Channel.state(Option<ChannelState>)
: Placeholder documentation for ChannelStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.vpc(Option<VpcOutputSettingsDescription>)
: Settings for VPC outputanywhere_settings(Option<DescribeAnywhereSettings>)
: Anywhere settings for this channel.channel_engine_version(Option<ChannelEngineVersionResponse>)
: Requested engine version for this channel.
- On failure, responds with
SdkError<StartChannelError>
Source§impl Client
impl Client
Sourcepub fn start_delete_monitor_deployment(
&self,
) -> StartDeleteMonitorDeploymentFluentBuilder
pub fn start_delete_monitor_deployment( &self, ) -> StartDeleteMonitorDeploymentFluentBuilder
Constructs a fluent builder for the StartDeleteMonitorDeployment
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
StartDeleteMonitorDeploymentOutput
with field(s):arn(Option<String>)
: A signal map’s ARN (Amazon Resource Name)cloud_watch_alarm_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.discovery_entry_point_arn(Option<String>)
: A top-level supported AWS resource ARN to discovery a signal map from.error_message(Option<String>)
: Error message associated with a failed creation or failed update attempt of a signal map.event_bridge_rule_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097failed_media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an incomplete AWS media workflow as a graph.id(Option<String>)
: A signal map’s id.last_discovered_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601last_successful_monitor_deployment(Option<SuccessfulMonitorDeployment>)
: Represents the latest successful monitor deployment of a signal map.media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an AWS media workflow as a graph.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601monitor_changes_pending_deployment(Option<bool>)
: If true, there are pending monitor changes for this signal map that can be deployed.monitor_deployment(Option<MonitorDeployment>)
: Represents the latest monitor deployment of a signal map.name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.status(Option<SignalMapStatus>)
: A signal map’s current status which is dependent on its lifecycle actions or associated jobs.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<StartDeleteMonitorDeploymentError>
Source§impl Client
impl Client
Sourcepub fn start_input_device(&self) -> StartInputDeviceFluentBuilder
pub fn start_input_device(&self) -> StartInputDeviceFluentBuilder
Constructs a fluent builder for the StartInputDevice
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to start. For example, hd-123456789abcdef.
- On success, responds with
StartInputDeviceOutput
- On failure, responds with
SdkError<StartInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn start_input_device_maintenance_window(
&self,
) -> StartInputDeviceMaintenanceWindowFluentBuilder
pub fn start_input_device_maintenance_window( &self, ) -> StartInputDeviceMaintenanceWindowFluentBuilder
Constructs a fluent builder for the StartInputDeviceMaintenanceWindow
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef.
- On success, responds with
StartInputDeviceMaintenanceWindowOutput
- On failure, responds with
SdkError<StartInputDeviceMaintenanceWindowError>
Source§impl Client
impl Client
Sourcepub fn start_monitor_deployment(&self) -> StartMonitorDeploymentFluentBuilder
pub fn start_monitor_deployment(&self) -> StartMonitorDeploymentFluentBuilder
Constructs a fluent builder for the StartMonitorDeployment
operation.
- The fluent builder is configurable:
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: false
Placeholder documentation for __booleanidentifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A signal map’s identifier. Can be either be its id or current name.
- On success, responds with
StartMonitorDeploymentOutput
with field(s):arn(Option<String>)
: A signal map’s ARN (Amazon Resource Name)cloud_watch_alarm_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.discovery_entry_point_arn(Option<String>)
: A top-level supported AWS resource ARN to discovery a signal map from.error_message(Option<String>)
: Error message associated with a failed creation or failed update attempt of a signal map.event_bridge_rule_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097failed_media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an incomplete AWS media workflow as a graph.id(Option<String>)
: A signal map’s id.last_discovered_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601last_successful_monitor_deployment(Option<SuccessfulMonitorDeployment>)
: Represents the latest successful monitor deployment of a signal map.media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an AWS media workflow as a graph.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601monitor_changes_pending_deployment(Option<bool>)
: If true, there are pending monitor changes for this signal map that can be deployed.monitor_deployment(Option<MonitorDeployment>)
: Represents the latest monitor deployment of a signal map.name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.status(Option<SignalMapStatus>)
: A signal map’s current status which is dependent on its lifecycle actions or associated jobs.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<StartMonitorDeploymentError>
Source§impl Client
impl Client
Sourcepub fn start_multiplex(&self) -> StartMultiplexFluentBuilder
pub fn start_multiplex(&self) -> StartMultiplexFluentBuilder
Constructs a fluent builder for the StartMultiplex
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex.
- On success, responds with
StartMultiplexOutput
with field(s):arn(Option<String>)
: The unique arn of the multiplex.availability_zones(Option<Vec::<String>>)
: A list of availability zones for the multiplex.destinations(Option<Vec::<MultiplexOutputDestination>>)
: A list of the multiplex output destinations.id(Option<String>)
: The unique id of the multiplex.multiplex_settings(Option<MultiplexSettings>)
: Configuration for a multiplex event.name(Option<String>)
: The name of the multiplex.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.program_count(Option<i32>)
: The number of programs in the multiplex.state(Option<MultiplexState>)
: The current state of the multiplex.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.
- On failure, responds with
SdkError<StartMultiplexError>
Source§impl Client
impl Client
Sourcepub fn start_update_signal_map(&self) -> StartUpdateSignalMapFluentBuilder
pub fn start_update_signal_map(&self) -> StartUpdateSignalMapFluentBuilder
Constructs a fluent builder for the StartUpdateSignalMap
operation.
- The fluent builder is configurable:
cloud_watch_alarm_template_group_identifiers(impl Into<String>)
/set_cloud_watch_alarm_template_group_identifiers(Option<Vec::<String>>)
:
required: false
Placeholder documentation for __listOf__stringPatternSdescription(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.discovery_entry_point_arn(impl Into<String>)
/set_discovery_entry_point_arn(Option<String>)
:
required: false
A top-level supported AWS resource ARN to discovery a signal map from.event_bridge_rule_template_group_identifiers(impl Into<String>)
/set_event_bridge_rule_template_group_identifiers(Option<Vec::<String>>)
:
required: false
Placeholder documentation for __listOf__stringPatternSforce_rediscovery(bool)
/set_force_rediscovery(Option<bool>)
:
required: false
If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A signal map’s identifier. Can be either be its id or current name.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
A resource’s name. Names must be unique within the scope of a resource type in a specific region.
- On success, responds with
StartUpdateSignalMapOutput
with field(s):arn(Option<String>)
: A signal map’s ARN (Amazon Resource Name)cloud_watch_alarm_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.discovery_entry_point_arn(Option<String>)
: A top-level supported AWS resource ARN to discovery a signal map from.error_message(Option<String>)
: Error message associated with a failed creation or failed update attempt of a signal map.event_bridge_rule_template_group_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringMin7Max11PatternAws097failed_media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an incomplete AWS media workflow as a graph.id(Option<String>)
: A signal map’s id.last_discovered_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601last_successful_monitor_deployment(Option<SuccessfulMonitorDeployment>)
: Represents the latest successful monitor deployment of a signal map.media_resource_map(Option<HashMap::<String, MediaResource>>)
: A map representing an AWS media workflow as a graph.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601monitor_changes_pending_deployment(Option<bool>)
: If true, there are pending monitor changes for this signal map that can be deployed.monitor_deployment(Option<MonitorDeployment>)
: Represents the latest monitor deployment of a signal map.name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.status(Option<SignalMapStatus>)
: A signal map’s current status which is dependent on its lifecycle actions or associated jobs.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<StartUpdateSignalMapError>
Source§impl Client
impl Client
Sourcepub fn stop_channel(&self) -> StopChannelFluentBuilder
pub fn stop_channel(&self) -> StopChannelFluentBuilder
Constructs a fluent builder for the StopChannel
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
A request to stop a running channel
- On success, responds with
StopChannelOutput
with field(s):arn(Option<String>)
: The unique arn of the channel.cdi_input_specification(Option<CdiInputSpecification>)
: Specification of CDI inputs for this channelchannel_class(Option<ChannelClass>)
: The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.destinations(Option<Vec::<OutputDestination>>)
: A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.egress_endpoints(Option<Vec::<ChannelEgressEndpoint>>)
: The endpoints where outgoing connections initiate fromencoder_settings(Option<EncoderSettings>)
: Encoder Settingsid(Option<String>)
: The unique id of the channel.input_attachments(Option<Vec::<InputAttachment>>)
: List of input attachments for channel.input_specification(Option<InputSpecification>)
: Specification of network and file inputs for this channellog_level(Option<LogLevel>)
: The log level being written to CloudWatch Logs.maintenance(Option<MaintenanceStatus>)
: Maintenance settings for this channel.name(Option<String>)
: The name of the channel. (user-mutable)pipeline_details(Option<Vec::<PipelineDetail>>)
: Runtime details for the pipelines of a running channel.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.role_arn(Option<String>)
: The Amazon Resource Name (ARN) of the role assumed when running the Channel.state(Option<ChannelState>)
: Placeholder documentation for ChannelStatetags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.vpc(Option<VpcOutputSettingsDescription>)
: Settings for VPC outputanywhere_settings(Option<DescribeAnywhereSettings>)
: Anywhere settings for this channel.channel_engine_version(Option<ChannelEngineVersionResponse>)
: Requested engine version for this channel.
- On failure, responds with
SdkError<StopChannelError>
Source§impl Client
impl Client
Sourcepub fn stop_input_device(&self) -> StopInputDeviceFluentBuilder
pub fn stop_input_device(&self) -> StopInputDeviceFluentBuilder
Constructs a fluent builder for the StopInputDevice
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device to stop. For example, hd-123456789abcdef.
- On success, responds with
StopInputDeviceOutput
- On failure, responds with
SdkError<StopInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn stop_multiplex(&self) -> StopMultiplexFluentBuilder
pub fn stop_multiplex(&self) -> StopMultiplexFluentBuilder
Constructs a fluent builder for the StopMultiplex
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex.
- On success, responds with
StopMultiplexOutput
with field(s):arn(Option<String>)
: The unique arn of the multiplex.availability_zones(Option<Vec::<String>>)
: A list of availability zones for the multiplex.destinations(Option<Vec::<MultiplexOutputDestination>>)
: A list of the multiplex output destinations.id(Option<String>)
: The unique id of the multiplex.multiplex_settings(Option<MultiplexSettings>)
: Configuration for a multiplex event.name(Option<String>)
: The name of the multiplex.pipelines_running_count(Option<i32>)
: The number of currently healthy pipelines.program_count(Option<i32>)
: The number of programs in the multiplex.state(Option<MultiplexState>)
: The current state of the multiplex.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.
- On failure, responds with
SdkError<StopMultiplexError>
Source§impl Client
impl Client
Sourcepub fn transfer_input_device(&self) -> TransferInputDeviceFluentBuilder
pub fn transfer_input_device(&self) -> TransferInputDeviceFluentBuilder
Constructs a fluent builder for the TransferInputDevice
operation.
- The fluent builder is configurable:
input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of this input device. For example, hd-123456789abcdef.target_customer_id(impl Into<String>)
/set_target_customer_id(Option<String>)
:
required: false
The AWS account ID (12 digits) for the recipient of the device transfer.target_region(impl Into<String>)
/set_target_region(Option<String>)
:
required: false
The target AWS region to transfer the device.transfer_message(impl Into<String>)
/set_transfer_message(Option<String>)
:
required: false
An optional message for the recipient. Maximum 280 characters.
- On success, responds with
TransferInputDeviceOutput
- On failure, responds with
SdkError<TransferInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn update_account_configuration(
&self,
) -> UpdateAccountConfigurationFluentBuilder
pub fn update_account_configuration( &self, ) -> UpdateAccountConfigurationFluentBuilder
Constructs a fluent builder for the UpdateAccountConfiguration
operation.
- The fluent builder is configurable:
account_configuration(AccountConfiguration)
/set_account_configuration(Option<AccountConfiguration>)
:
required: false
Placeholder documentation for AccountConfiguration
- On success, responds with
UpdateAccountConfigurationOutput
with field(s):account_configuration(Option<AccountConfiguration>)
: Placeholder documentation for AccountConfiguration
- On failure, responds with
SdkError<UpdateAccountConfigurationError>
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:
cdi_input_specification(CdiInputSpecification)
/set_cdi_input_specification(Option<CdiInputSpecification>)
:
required: false
Specification of CDI inputs for this channelchannel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
channel IDdestinations(OutputDestination)
/set_destinations(Option<Vec::<OutputDestination>>)
:
required: false
A list of output destinations for this channel.encoder_settings(EncoderSettings)
/set_encoder_settings(Option<EncoderSettings>)
:
required: false
The encoder settings for this channel.input_attachments(InputAttachment)
/set_input_attachments(Option<Vec::<InputAttachment>>)
:
required: false
Placeholder documentation for __listOfInputAttachmentinput_specification(InputSpecification)
/set_input_specification(Option<InputSpecification>)
:
required: false
Specification of network and file inputs for this channellog_level(LogLevel)
/set_log_level(Option<LogLevel>)
:
required: false
The log level to write to CloudWatch Logs.maintenance(MaintenanceUpdateSettings)
/set_maintenance(Option<MaintenanceUpdateSettings>)
:
required: false
Maintenance settings for this channel.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the channel.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: false
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.channel_engine_version(ChannelEngineVersionRequest)
/set_channel_engine_version(Option<ChannelEngineVersionRequest>)
:
required: false
Channel engine version for this channeldry_run(bool)
/set_dry_run(Option<bool>)
:
required: false
Placeholder documentation for __booleananywhere_settings(AnywhereSettings)
/set_anywhere_settings(Option<AnywhereSettings>)
:
required: false
The Elemental Anywhere settings for this channel.
- On success, responds with
UpdateChannelOutput
with field(s):channel(Option<Channel>)
: Placeholder documentation for Channel
- On failure, responds with
SdkError<UpdateChannelError>
Source§impl Client
impl Client
Sourcepub fn update_channel_class(&self) -> UpdateChannelClassFluentBuilder
pub fn update_channel_class(&self) -> UpdateChannelClassFluentBuilder
Constructs a fluent builder for the UpdateChannelClass
operation.
- The fluent builder is configurable:
channel_class(ChannelClass)
/set_channel_class(Option<ChannelClass>)
:
required: true
The channel class that you wish to update this channel to use.channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
Channel Id of the channel whose class should be updated.destinations(OutputDestination)
/set_destinations(Option<Vec::<OutputDestination>>)
:
required: false
A list of output destinations for this channel.
- On success, responds with
UpdateChannelClassOutput
with field(s):channel(Option<Channel>)
: Placeholder documentation for Channel
- On failure, responds with
SdkError<UpdateChannelClassError>
Source§impl Client
impl Client
Sourcepub fn update_channel_placement_group(
&self,
) -> UpdateChannelPlacementGroupFluentBuilder
pub fn update_channel_placement_group( &self, ) -> UpdateChannelPlacementGroupFluentBuilder
Constructs a fluent builder for the UpdateChannelPlacementGroup
operation.
- The fluent builder is configurable:
channel_placement_group_id(impl Into<String>)
/set_channel_placement_group_id(Option<String>)
:
required: true
The ID of the channel placement group.cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the cluster.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.nodes(impl Into<String>)
/set_nodes(Option<Vec::<String>>)
:
required: false
Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.
- On success, responds with
UpdateChannelPlacementGroupOutput
with field(s):arn(Option<String>)
: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.channels(Option<Vec::<String>>)
: Used in ListChannelPlacementGroupsResultcluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.id(Option<String>)
: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.name(Option<String>)
: The name that you specified for the ChannelPlacementGroup.nodes(Option<Vec::<String>>)
: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.state(Option<ChannelPlacementGroupState>)
: The current state of the ChannelPlacementGroup.
- On failure, responds with
SdkError<UpdateChannelPlacementGroupError>
Source§impl Client
impl Client
Sourcepub fn update_cloud_watch_alarm_template(
&self,
) -> UpdateCloudWatchAlarmTemplateFluentBuilder
pub fn update_cloud_watch_alarm_template( &self, ) -> UpdateCloudWatchAlarmTemplateFluentBuilder
Constructs a fluent builder for the UpdateCloudWatchAlarmTemplate
operation.
- The fluent builder is configurable:
comparison_operator(CloudWatchAlarmTemplateComparisonOperator)
/set_comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)
:
required: false
The comparison operator used to compare the specified statistic and the threshold.datapoints_to_alarm(i32)
/set_datapoints_to_alarm(Option<i32>)
:
required: false
The number of datapoints within the evaluation period that must be breaching to trigger the alarm.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.evaluation_periods(i32)
/set_evaluation_periods(Option<i32>)
:
required: false
The number of periods over which data is compared to the specified threshold.group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: false
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template’s identifier. Can be either be its id or current name.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: false
The name of the metric associated with the alarm. Must be compatible with targetResourceType.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
A resource’s name. Names must be unique within the scope of a resource type in a specific region.period(i32)
/set_period(Option<i32>)
:
required: false
The period, in seconds, over which the specified statistic is applied.statistic(CloudWatchAlarmTemplateStatistic)
/set_statistic(Option<CloudWatchAlarmTemplateStatistic>)
:
required: false
The statistic to apply to the alarm’s metric data.target_resource_type(CloudWatchAlarmTemplateTargetResourceType)
/set_target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)
:
required: false
The resource type this template should dynamically generate cloudwatch metric alarms for.threshold(f64)
/set_threshold(Option<f64>)
:
required: false
The threshold value to compare with the specified statistic.treat_missing_data(CloudWatchAlarmTemplateTreatMissingData)
/set_treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)
:
required: false
Specifies how missing data points are treated when evaluating the alarm’s condition.
- On success, responds with
UpdateCloudWatchAlarmTemplateOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template’s ARN (Amazon Resource Name)comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)
: The comparison operator used to compare the specified statistic and the threshold.created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601datapoints_to_alarm(Option<i32>)
: The number of datapoints within the evaluation period that must be breaching to trigger the alarm.description(Option<String>)
: A resource’s optional description.evaluation_periods(Option<i32>)
: The number of periods over which data is compared to the specified threshold.group_id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: A cloudwatch alarm template’s id. AWS provided templates have ids that start withaws-
metric_name(Option<String>)
: The name of the metric associated with the alarm. Must be compatible with targetResourceType.modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.period(Option<i32>)
: The period, in seconds, over which the specified statistic is applied.statistic(Option<CloudWatchAlarmTemplateStatistic>)
: The statistic to apply to the alarm’s metric data.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)
: The resource type this template should dynamically generate cloudwatch metric alarms for.threshold(Option<f64>)
: The threshold value to compare with the specified statistic.treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)
: Specifies how missing data points are treated when evaluating the alarm’s condition.
- On failure, responds with
SdkError<UpdateCloudWatchAlarmTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_cloud_watch_alarm_template_group(
&self,
) -> UpdateCloudWatchAlarmTemplateGroupFluentBuilder
pub fn update_cloud_watch_alarm_template_group( &self, ) -> UpdateCloudWatchAlarmTemplateGroupFluentBuilder
Constructs a fluent builder for the UpdateCloudWatchAlarmTemplateGroup
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
A cloudwatch alarm template group’s identifier. Can be either be its id or current name.
- On success, responds with
UpdateCloudWatchAlarmTemplateGroupOutput
with field(s):arn(Option<String>)
: A cloudwatch alarm template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: A cloudwatch alarm template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<UpdateCloudWatchAlarmTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn update_cluster(&self) -> UpdateClusterFluentBuilder
pub fn update_cluster(&self) -> UpdateClusterFluentBuilder
Constructs a fluent builder for the UpdateCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clustername(impl Into<String>)
/set_name(Option<String>)
:
required: false
Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can’t change the name. Names are case-sensitive.network_settings(ClusterNetworkSettingsUpdateRequest)
/set_network_settings(Option<ClusterNetworkSettingsUpdateRequest>)
:
required: false
Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with.
- On success, responds with
UpdateClusterOutput
with field(s):arn(Option<String>)
: The ARN of the Cluster.channel_ids(Option<Vec::<String>>)
: An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.cluster_type(Option<ClusterType>)
: The hardware type for the Clusterid(Option<String>)
: The unique ID of the Cluster.name(Option<String>)
: The user-specified name of the Cluster.network_settings(Option<ClusterNetworkSettings>)
: Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.state(Option<ClusterState>)
: The current state of the Cluster.
- On failure, responds with
SdkError<UpdateClusterError>
Source§impl Client
impl Client
Sourcepub fn update_event_bridge_rule_template(
&self,
) -> UpdateEventBridgeRuleTemplateFluentBuilder
pub fn update_event_bridge_rule_template( &self, ) -> UpdateEventBridgeRuleTemplateFluentBuilder
Constructs a fluent builder for the UpdateEventBridgeRuleTemplate
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.event_targets(EventBridgeRuleTemplateTarget)
/set_event_targets(Option<Vec::<EventBridgeRuleTemplateTarget>>)
:
required: false
Placeholder documentation for __listOfEventBridgeRuleTemplateTargetevent_type(EventBridgeRuleTemplateEventType)
/set_event_type(Option<EventBridgeRuleTemplateEventType>)
:
required: false
The type of event to match with the rule.group_identifier(impl Into<String>)
/set_group_identifier(Option<String>)
:
required: false
An eventbridge rule template group’s identifier. Can be either be its id or current name.identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template’s identifier. Can be either be its id or current name.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
A resource’s name. Names must be unique within the scope of a resource type in a specific region.
- On success, responds with
UpdateEventBridgeRuleTemplateOutput
with field(s):arn(Option<String>)
: An eventbridge rule template’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.event_targets(Option<Vec::<EventBridgeRuleTemplateTarget>>)
: Placeholder documentation for __listOfEventBridgeRuleTemplateTargetevent_type(Option<EventBridgeRuleTemplateEventType>)
: The type of event to match with the rule.group_id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
id(Option<String>)
: An eventbridge rule template’s id. AWS provided templates have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<UpdateEventBridgeRuleTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_event_bridge_rule_template_group(
&self,
) -> UpdateEventBridgeRuleTemplateGroupFluentBuilder
pub fn update_event_bridge_rule_template_group( &self, ) -> UpdateEventBridgeRuleTemplateGroupFluentBuilder
Constructs a fluent builder for the UpdateEventBridgeRuleTemplateGroup
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A resource’s optional description.identifier(impl Into<String>)
/set_identifier(Option<String>)
:
required: true
An eventbridge rule template group’s identifier. Can be either be its id or current name.
- On success, responds with
UpdateEventBridgeRuleTemplateGroupOutput
with field(s):arn(Option<String>)
: An eventbridge rule template group’s ARN (Amazon Resource Name)created_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601description(Option<String>)
: A resource’s optional description.id(Option<String>)
: An eventbridge rule template group’s id. AWS provided template groups have ids that start withaws-
modified_at(Option<DateTime>)
: Placeholder documentation for __timestampIso8601name(Option<String>)
: A resource’s name. Names must be unique within the scope of a resource type in a specific region.tags(Option<HashMap::<String, String>>)
: Represents the tags associated with a resource.
- On failure, responds with
SdkError<UpdateEventBridgeRuleTemplateGroupError>
Source§impl Client
impl Client
Sourcepub fn update_input(&self) -> UpdateInputFluentBuilder
pub fn update_input(&self) -> UpdateInputFluentBuilder
Constructs a fluent builder for the UpdateInput
operation.
- The fluent builder is configurable:
destinations(InputDestinationRequest)
/set_destinations(Option<Vec::<InputDestinationRequest>>)
:
required: false
Destination settings for PUSH type inputs.input_devices(InputDeviceRequest)
/set_input_devices(Option<Vec::<InputDeviceRequest>>)
:
required: false
Settings for the devices.input_id(impl Into<String>)
/set_input_id(Option<String>)
:
required: true
Unique ID of the input.input_security_groups(impl Into<String>)
/set_input_security_groups(Option<Vec::<String>>)
:
required: false
A list of security groups referenced by IDs to attach to the input.media_connect_flows(MediaConnectFlowRequest)
/set_media_connect_flows(Option<Vec::<MediaConnectFlowRequest>>)
:
required: false
A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name of the input.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: false
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.sources(InputSourceRequest)
/set_sources(Option<Vec::<InputSourceRequest>>)
:
required: false
The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.srt_settings(SrtSettingsRequest)
/set_srt_settings(Option<SrtSettingsRequest>)
:
required: false
The settings associated with an SRT input.multicast_settings(MulticastSettingsUpdateRequest)
/set_multicast_settings(Option<MulticastSettingsUpdateRequest>)
:
required: false
Multicast Input settings.smpte2110_receiver_group_settings(Smpte2110ReceiverGroupSettings)
/set_smpte2110_receiver_group_settings(Option<Smpte2110ReceiverGroupSettings>)
:
required: false
Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.sdi_sources(impl Into<String>)
/set_sdi_sources(Option<Vec::<String>>)
:
required: false
SDI Sources for this Input.
- On success, responds with
UpdateInputOutput
with field(s):input(Option<Input>)
: Placeholder documentation for Input
- On failure, responds with
SdkError<UpdateInputError>
Source§impl Client
impl Client
Sourcepub fn update_input_device(&self) -> UpdateInputDeviceFluentBuilder
pub fn update_input_device(&self) -> UpdateInputDeviceFluentBuilder
Constructs a fluent builder for the UpdateInputDevice
operation.
- The fluent builder is configurable:
hd_device_settings(InputDeviceConfigurableSettings)
/set_hd_device_settings(Option<InputDeviceConfigurableSettings>)
:
required: false
The settings that you want to apply to the HD input device.input_device_id(impl Into<String>)
/set_input_device_id(Option<String>)
:
required: true
The unique ID of the input device. For example, hd-123456789abcdef.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name that you assigned to this input device (not the unique ID).uhd_device_settings(InputDeviceConfigurableSettings)
/set_uhd_device_settings(Option<InputDeviceConfigurableSettings>)
:
required: false
The settings that you want to apply to the UHD input device.availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:
required: false
The Availability Zone you want associated with this input device.
- On success, responds with
UpdateInputDeviceOutput
with field(s):arn(Option<String>)
: The unique ARN of the input device.connection_state(Option<InputDeviceConnectionState>)
: The state of the connection between the input device and AWS.device_settings_sync_state(Option<DeviceSettingsSyncState>)
: The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.device_update_status(Option<DeviceUpdateStatus>)
: The status of software on the input device.hd_device_settings(Option<InputDeviceHdSettings>)
: Settings that describe an input device that is type HD.id(Option<String>)
: The unique ID of the input device.mac_address(Option<String>)
: The network MAC address of the input device.name(Option<String>)
: A name that you specify for the input device.network_settings(Option<InputDeviceNetworkSettings>)
: The network settings for the input device.serial_number(Option<String>)
: The unique serial number of the input device.r#type(Option<InputDeviceType>)
: The type of the input device.uhd_device_settings(Option<InputDeviceUhdSettings>)
: Settings that describe an input device that is type UHD.tags(Option<HashMap::<String, String>>)
: A collection of key-value pairs.availability_zone(Option<String>)
: The Availability Zone associated with this input device.medialive_input_arns(Option<Vec::<String>>)
: An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.output_type(Option<InputDeviceOutputType>)
: The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.
- On failure, responds with
SdkError<UpdateInputDeviceError>
Source§impl Client
impl Client
Sourcepub fn update_input_security_group(
&self,
) -> UpdateInputSecurityGroupFluentBuilder
pub fn update_input_security_group( &self, ) -> UpdateInputSecurityGroupFluentBuilder
Constructs a fluent builder for the UpdateInputSecurityGroup
operation.
- The fluent builder is configurable:
input_security_group_id(impl Into<String>)
/set_input_security_group_id(Option<String>)
:
required: true
The id of the Input Security Group to update.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
A collection of key-value pairs.whitelist_rules(InputWhitelistRuleCidr)
/set_whitelist_rules(Option<Vec::<InputWhitelistRuleCidr>>)
:
required: false
List of IPv4 CIDR addresses to whitelist
- On success, responds with
UpdateInputSecurityGroupOutput
with field(s):security_group(Option<InputSecurityGroup>)
: An Input Security Group
- On failure, responds with
SdkError<UpdateInputSecurityGroupError>
Source§impl Client
impl Client
Sourcepub fn update_multiplex(&self) -> UpdateMultiplexFluentBuilder
pub fn update_multiplex(&self) -> UpdateMultiplexFluentBuilder
Constructs a fluent builder for the UpdateMultiplex
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
ID of the multiplex to update.multiplex_settings(MultiplexSettings)
/set_multiplex_settings(Option<MultiplexSettings>)
:
required: false
The new settings for a multiplex.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name of the multiplex.packet_identifiers_mapping(impl Into<String>, MultiplexProgramPacketIdentifiersMap)
/set_packet_identifiers_mapping(Option<HashMap::<String, MultiplexProgramPacketIdentifiersMap>>)
:
required: false
Placeholder documentation for MultiplexPacketIdentifiersMapping
- On success, responds with
UpdateMultiplexOutput
with field(s):multiplex(Option<Multiplex>)
: The updated multiplex.
- On failure, responds with
SdkError<UpdateMultiplexError>
Source§impl Client
impl Client
Sourcepub fn update_multiplex_program(&self) -> UpdateMultiplexProgramFluentBuilder
pub fn update_multiplex_program(&self) -> UpdateMultiplexProgramFluentBuilder
Constructs a fluent builder for the UpdateMultiplexProgram
operation.
- The fluent builder is configurable:
multiplex_id(impl Into<String>)
/set_multiplex_id(Option<String>)
:
required: true
The ID of the multiplex of the program to update.multiplex_program_settings(MultiplexProgramSettings)
/set_multiplex_program_settings(Option<MultiplexProgramSettings>)
:
required: false
The new settings for a multiplex program.program_name(impl Into<String>)
/set_program_name(Option<String>)
:
required: true
The name of the program to update.
- On success, responds with
UpdateMultiplexProgramOutput
with field(s):multiplex_program(Option<MultiplexProgram>)
: The updated multiplex program.
- On failure, responds with
SdkError<UpdateMultiplexProgramError>
Source§impl Client
impl Client
Sourcepub fn update_network(&self) -> UpdateNetworkFluentBuilder
pub fn update_network(&self) -> UpdateNetworkFluentBuilder
Constructs a fluent builder for the UpdateNetwork
operation.
- The fluent builder is configurable:
ip_pools(IpPoolUpdateRequest)
/set_ip_pools(Option<Vec::<IpPoolUpdateRequest>>)
:
required: false
Include this parameter only if you want to change the pool of IP addresses in the network. An array of IpPoolCreateRequests that identify a collection of IP addresses in this network that you want to reserve for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPoolUpdateRequest specifies one CIDR block.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Include this parameter only if you want to change the name of the Network. Specify a name that is unique in the AWS account. Names are case-sensitive.network_id(impl Into<String>)
/set_network_id(Option<String>)
:
required: true
The ID of the networkroutes(RouteUpdateRequest)
/set_routes(Option<Vec::<RouteUpdateRequest>>)
:
required: false
Include this parameter only if you want to change or add routes in the Network. An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
- On success, responds with
UpdateNetworkOutput
with field(s):arn(Option<String>)
: The ARN of this Network. It is automatically assigned when the Network is created.associated_cluster_ids(Option<Vec::<String>>)
: Placeholder documentation for __listOf__stringid(Option<String>)
: The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.ip_pools(Option<Vec::<IpPool>>)
: An array of IpPools in your organization’s network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.name(Option<String>)
: The name that you specified for the Network.routes(Option<Vec::<Route>>)
: An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic.state(Option<NetworkState>)
: The current state of the Network. Only MediaLive Anywhere can change the state.
- On failure, responds with
SdkError<UpdateNetworkError>
Source§impl Client
impl Client
Sourcepub fn update_node(&self) -> UpdateNodeFluentBuilder
pub fn update_node(&self) -> UpdateNodeFluentBuilder
Constructs a fluent builder for the UpdateNode
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clustername(impl Into<String>)
/set_name(Option<String>)
:
required: false
Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.node_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: true
The ID of the node.role(NodeRole)
/set_role(Option<NodeRole>)
:
required: false
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.sdi_source_mappings(SdiSourceMappingUpdateRequest)
/set_sdi_source_mappings(Option<Vec::<SdiSourceMappingUpdateRequest>>)
:
required: false
The mappings of a SDI capture card port to a logical SDI data stream
- On success, responds with
UpdateNodeOutput
with field(s):arn(Option<String>)
: The ARN of the Node. It is automatically assigned when the Node is created.channel_placement_groups(Option<Vec::<String>>)
: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.cluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.connection_state(Option<NodeConnectionState>)
: The current connection state of the Node.id(Option<String>)
: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.instance_arn(Option<String>)
: The ARN of the EC2 instance hosting the Node.name(Option<String>)
: The name that you specified for the Node.node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
: Documentation update neededrole(Option<NodeRole>)
: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.state(Option<NodeState>)
: The current state of the Node.sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)
: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
- On failure, responds with
SdkError<UpdateNodeError>
Source§impl Client
impl Client
Sourcepub fn update_node_state(&self) -> UpdateNodeStateFluentBuilder
pub fn update_node_state(&self) -> UpdateNodeStateFluentBuilder
Constructs a fluent builder for the UpdateNodeState
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: true
The ID of the clusternode_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: true
The ID of the node.state(UpdateNodeStateShape)
/set_state(Option<UpdateNodeStateShape>)
:
required: false
The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won’t use it.
- On success, responds with
UpdateNodeStateOutput
with field(s):arn(Option<String>)
: The ARN of the Node. It is automatically assigned when the Node is created.channel_placement_groups(Option<Vec::<String>>)
: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.cluster_id(Option<String>)
: The ID of the Cluster that the Node belongs to.connection_state(Option<NodeConnectionState>)
: The current connection state of the Node.id(Option<String>)
: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.instance_arn(Option<String>)
: The ARN of the EC2 instance hosting the Node.name(Option<String>)
: The name that you specified for the Node.node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)
: Documentation update neededrole(Option<NodeRole>)
: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.state(Option<NodeState>)
: The current state of the Node.sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)
: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
- On failure, responds with
SdkError<UpdateNodeStateError>
Source§impl Client
impl Client
Sourcepub fn update_reservation(&self) -> UpdateReservationFluentBuilder
pub fn update_reservation(&self) -> UpdateReservationFluentBuilder
Constructs a fluent builder for the UpdateReservation
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Name of the reservationrenewal_settings(RenewalSettings)
/set_renewal_settings(Option<RenewalSettings>)
:
required: false
Renewal settings for the reservationreservation_id(impl Into<String>)
/set_reservation_id(Option<String>)
:
required: true
Unique reservation ID, e.g. ‘1234567’
- On success, responds with
UpdateReservationOutput
with field(s):reservation(Option<Reservation>)
: Reserved resources available to use
- On failure, responds with
SdkError<UpdateReservationError>
Source§impl Client
impl Client
Sourcepub fn update_sdi_source(&self) -> UpdateSdiSourceFluentBuilder
pub fn update_sdi_source(&self) -> UpdateSdiSourceFluentBuilder
Constructs a fluent builder for the UpdateSdiSource
operation.
- The fluent builder is configurable:
mode(SdiSourceMode)
/set_mode(Option<SdiSourceMode>)
:
required: false
Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.sdi_source_id(impl Into<String>)
/set_sdi_source_id(Option<String>)
:
required: true
The ID of the SdiSourcer#type(SdiSourceType)
/set_type(Option<SdiSourceType>)
:
required: false
Include this parameter only if you want to change the mode. Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.
- On success, responds with
UpdateSdiSourceOutput
with field(s):sdi_source(Option<SdiSource>)
: Settings for the SDI source.
- On failure, responds with
SdkError<UpdateSdiSourceError>
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§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_channel_created(&self) -> ChannelCreatedFluentBuilder
fn wait_until_channel_created(&self) -> ChannelCreatedFluentBuilder
Source§fn wait_until_channel_deleted(&self) -> ChannelDeletedFluentBuilder
fn wait_until_channel_deleted(&self) -> ChannelDeletedFluentBuilder
Source§fn wait_until_channel_running(&self) -> ChannelRunningFluentBuilder
fn wait_until_channel_running(&self) -> ChannelRunningFluentBuilder
Source§fn wait_until_channel_stopped(&self) -> ChannelStoppedFluentBuilder
fn wait_until_channel_stopped(&self) -> ChannelStoppedFluentBuilder
Source§fn wait_until_channel_placement_group_assigned(
&self,
) -> ChannelPlacementGroupAssignedFluentBuilder
fn wait_until_channel_placement_group_assigned( &self, ) -> ChannelPlacementGroupAssignedFluentBuilder
Source§fn wait_until_channel_placement_group_deleted(
&self,
) -> ChannelPlacementGroupDeletedFluentBuilder
fn wait_until_channel_placement_group_deleted( &self, ) -> ChannelPlacementGroupDeletedFluentBuilder
Source§fn wait_until_channel_placement_group_unassigned(
&self,
) -> ChannelPlacementGroupUnassignedFluentBuilder
fn wait_until_channel_placement_group_unassigned( &self, ) -> ChannelPlacementGroupUnassignedFluentBuilder
Source§fn wait_until_cluster_created(&self) -> ClusterCreatedFluentBuilder
fn wait_until_cluster_created(&self) -> ClusterCreatedFluentBuilder
Source§fn wait_until_cluster_deleted(&self) -> ClusterDeletedFluentBuilder
fn wait_until_cluster_deleted(&self) -> ClusterDeletedFluentBuilder
Source§fn wait_until_input_attached(&self) -> InputAttachedFluentBuilder
fn wait_until_input_attached(&self) -> InputAttachedFluentBuilder
Source§fn wait_until_input_deleted(&self) -> InputDeletedFluentBuilder
fn wait_until_input_deleted(&self) -> InputDeletedFluentBuilder
Source§fn wait_until_input_detached(&self) -> InputDetachedFluentBuilder
fn wait_until_input_detached(&self) -> InputDetachedFluentBuilder
Source§fn wait_until_multiplex_created(&self) -> MultiplexCreatedFluentBuilder
fn wait_until_multiplex_created(&self) -> MultiplexCreatedFluentBuilder
Source§fn wait_until_multiplex_deleted(&self) -> MultiplexDeletedFluentBuilder
fn wait_until_multiplex_deleted(&self) -> MultiplexDeletedFluentBuilder
Source§fn wait_until_multiplex_running(&self) -> MultiplexRunningFluentBuilder
fn wait_until_multiplex_running(&self) -> MultiplexRunningFluentBuilder
Source§fn wait_until_multiplex_stopped(&self) -> MultiplexStoppedFluentBuilder
fn wait_until_multiplex_stopped(&self) -> MultiplexStoppedFluentBuilder
Source§fn wait_until_node_deregistered(&self) -> NodeDeregisteredFluentBuilder
fn wait_until_node_deregistered(&self) -> NodeDeregisteredFluentBuilder
Source§fn wait_until_node_registered(&self) -> NodeRegisteredFluentBuilder
fn wait_until_node_registered(&self) -> NodeRegisteredFluentBuilder
Source§fn wait_until_signal_map_created(&self) -> SignalMapCreatedFluentBuilder
fn wait_until_signal_map_created(&self) -> SignalMapCreatedFluentBuilder
Source§fn wait_until_signal_map_monitor_deleted(
&self,
) -> SignalMapMonitorDeletedFluentBuilder
fn wait_until_signal_map_monitor_deleted( &self, ) -> SignalMapMonitorDeletedFluentBuilder
Source§fn wait_until_signal_map_monitor_deployed(
&self,
) -> SignalMapMonitorDeployedFluentBuilder
fn wait_until_signal_map_monitor_deployed( &self, ) -> SignalMapMonitorDeployedFluentBuilder
Source§fn wait_until_signal_map_updated(&self) -> SignalMapUpdatedFluentBuilder
fn wait_until_signal_map_updated(&self) -> SignalMapUpdatedFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);