pub struct StartCompositionFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartComposition.
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
-
When
StopCompositionis called. -
After a 1-minute timeout, when all participants are disconnected from the stage.
-
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
-
When broadcasting to the IVS channel fails and all retries are exhausted.
-
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Implementations§
Source§impl StartCompositionFluentBuilder
impl StartCompositionFluentBuilder
Sourcepub fn as_input(&self) -> &StartCompositionInputBuilder
pub fn as_input(&self) -> &StartCompositionInputBuilder
Access the StartComposition as a reference.
Sourcepub async fn send(
self,
) -> Result<StartCompositionOutput, SdkError<StartCompositionError, HttpResponse>>
pub async fn send( self, ) -> Result<StartCompositionOutput, SdkError<StartCompositionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartCompositionOutput, StartCompositionError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartCompositionOutput, StartCompositionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn stage_arn(self, input: impl Into<String>) -> Self
pub fn stage_arn(self, input: impl Into<String>) -> Self
ARN of the stage to be used for compositing.
Sourcepub fn set_stage_arn(self, input: Option<String>) -> Self
pub fn set_stage_arn(self, input: Option<String>) -> Self
ARN of the stage to be used for compositing.
Sourcepub fn get_stage_arn(&self) -> &Option<String>
pub fn get_stage_arn(&self) -> &Option<String>
ARN of the stage to be used for compositing.
Sourcepub fn idempotency_token(self, input: impl Into<String>) -> Self
pub fn idempotency_token(self, input: impl Into<String>) -> Self
Idempotency token.
Sourcepub fn set_idempotency_token(self, input: Option<String>) -> Self
pub fn set_idempotency_token(self, input: Option<String>) -> Self
Idempotency token.
Sourcepub fn get_idempotency_token(&self) -> &Option<String>
pub fn get_idempotency_token(&self) -> &Option<String>
Idempotency token.
Sourcepub fn layout(self, input: LayoutConfiguration) -> Self
pub fn layout(self, input: LayoutConfiguration) -> Self
Layout object to configure composition parameters.
Sourcepub fn set_layout(self, input: Option<LayoutConfiguration>) -> Self
pub fn set_layout(self, input: Option<LayoutConfiguration>) -> Self
Layout object to configure composition parameters.
Sourcepub fn get_layout(&self) -> &Option<LayoutConfiguration>
pub fn get_layout(&self) -> &Option<LayoutConfiguration>
Layout object to configure composition parameters.
Sourcepub fn destinations(self, input: DestinationConfiguration) -> Self
pub fn destinations(self, input: DestinationConfiguration) -> Self
Appends an item to destinations.
To override the contents of this collection use set_destinations.
Array of destination configuration.
Sourcepub fn set_destinations(
self,
input: Option<Vec<DestinationConfiguration>>,
) -> Self
pub fn set_destinations( self, input: Option<Vec<DestinationConfiguration>>, ) -> Self
Array of destination configuration.
Sourcepub fn get_destinations(&self) -> &Option<Vec<DestinationConfiguration>>
pub fn get_destinations(&self) -> &Option<Vec<DestinationConfiguration>>
Array of destination configuration.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Trait Implementations§
Source§impl Clone for StartCompositionFluentBuilder
impl Clone for StartCompositionFluentBuilder
Source§fn clone(&self) -> StartCompositionFluentBuilder
fn clone(&self) -> StartCompositionFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for StartCompositionFluentBuilder
impl !RefUnwindSafe for StartCompositionFluentBuilder
impl Send for StartCompositionFluentBuilder
impl Sync for StartCompositionFluentBuilder
impl Unpin for StartCompositionFluentBuilder
impl !UnwindSafe for StartCompositionFluentBuilder
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);