aws_sdk_mediaconnect/client/
update_flow_entitlement.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateFlowEntitlement`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`description(impl Into<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_description):<br>required: **false**<br><p>A description of the entitlement. This description appears only on the MediaConnect console and will not be seen by the subscriber or end user.</p><br>
7    ///   - [`encryption(UpdateEncryption)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::encryption) / [`set_encryption(Option<UpdateEncryption>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_encryption):<br>required: **false**<br><p>The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.</p><br>
8    ///   - [`entitlement_arn(impl Into<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::entitlement_arn) / [`set_entitlement_arn(Option<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_entitlement_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the entitlement that you want to update.</p><br>
9    ///   - [`entitlement_status(EntitlementStatus)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::entitlement_status) / [`set_entitlement_status(Option<EntitlementStatus>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_entitlement_status):<br>required: **false**<br><p>An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the <code>entitlementStatus</code> field in your request, MediaConnect leaves the value unchanged.</p><br>
10    ///   - [`flow_arn(impl Into<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::flow_arn) / [`set_flow_arn(Option<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_flow_arn):<br>required: **true**<br><p>The ARN of the flow that is associated with the entitlement that you want to update.</p><br>
11    ///   - [`subscribers(impl Into<String>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::subscribers) / [`set_subscribers(Option<Vec::<String>>)`](crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::set_subscribers):<br>required: **false**<br><p>The Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.</p><br>
12    /// - On success, responds with [`UpdateFlowEntitlementOutput`](crate::operation::update_flow_entitlement::UpdateFlowEntitlementOutput) with field(s):
13    ///   - [`entitlement(Option<Entitlement>)`](crate::operation::update_flow_entitlement::UpdateFlowEntitlementOutput::entitlement): <p>The new configuration of the entitlement that you updated.</p>
14    ///   - [`flow_arn(Option<String>)`](crate::operation::update_flow_entitlement::UpdateFlowEntitlementOutput::flow_arn): <p>The ARN of the flow that this entitlement was granted on.</p>
15    /// - On failure, responds with [`SdkError<UpdateFlowEntitlementError>`](crate::operation::update_flow_entitlement::UpdateFlowEntitlementError)
16    pub fn update_flow_entitlement(&self) -> crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder {
17        crate::operation::update_flow_entitlement::builders::UpdateFlowEntitlementFluentBuilder::new(self.handle.clone())
18    }
19}