Struct Client

Source
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

Source

pub fn accept_input_device_transfer( &self, ) -> AcceptInputDeviceTransferFluentBuilder

Constructs a fluent builder for the AcceptInputDeviceTransfer operation.

Source§

impl Client

Source

pub fn batch_delete(&self) -> BatchDeleteFluentBuilder

Constructs a fluent builder for the BatchDelete operation.

Source§

impl Client

Source

pub fn batch_start(&self) -> BatchStartFluentBuilder

Constructs a fluent builder for the BatchStart operation.

Source§

impl Client

Source

pub fn batch_stop(&self) -> BatchStopFluentBuilder

Constructs a fluent builder for the BatchStop operation.

Source§

impl Client

Source

pub fn batch_update_schedule(&self) -> BatchUpdateScheduleFluentBuilder

Constructs a fluent builder for the BatchUpdateSchedule operation.

Source§

impl Client

Source

pub fn cancel_input_device_transfer( &self, ) -> CancelInputDeviceTransferFluentBuilder

Constructs a fluent builder for the CancelInputDeviceTransfer operation.

Source§

impl Client

Source

pub fn claim_device(&self) -> ClaimDeviceFluentBuilder

Constructs a fluent builder for the ClaimDevice operation.

Source§

impl Client

Source

pub fn create_channel(&self) -> CreateChannelFluentBuilder

Constructs a fluent builder for the CreateChannel operation.

Source§

impl Client

Source

pub fn create_channel_placement_group( &self, ) -> CreateChannelPlacementGroupFluentBuilder

Constructs a fluent builder for the CreateChannelPlacementGroup operation.

Source§

impl Client

Source

pub fn create_cloud_watch_alarm_template( &self, ) -> CreateCloudWatchAlarmTemplateFluentBuilder

Constructs a fluent builder for the CreateCloudWatchAlarmTemplate operation.

Source§

impl Client

Source

pub fn create_cloud_watch_alarm_template_group( &self, ) -> CreateCloudWatchAlarmTemplateGroupFluentBuilder

Constructs a fluent builder for the CreateCloudWatchAlarmTemplateGroup operation.

Source§

impl Client

Source

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

Source§

impl Client

Source

pub fn create_event_bridge_rule_template( &self, ) -> CreateEventBridgeRuleTemplateFluentBuilder

Constructs a fluent builder for the CreateEventBridgeRuleTemplate operation.

Source§

impl Client

Source

pub fn create_event_bridge_rule_template_group( &self, ) -> CreateEventBridgeRuleTemplateGroupFluentBuilder

Constructs a fluent builder for the CreateEventBridgeRuleTemplateGroup operation.

Source§

impl Client

Source

pub fn create_input(&self) -> CreateInputFluentBuilder

Constructs a fluent builder for the CreateInput operation.

Source§

impl Client

Source

pub fn create_input_security_group( &self, ) -> CreateInputSecurityGroupFluentBuilder

Constructs a fluent builder for the CreateInputSecurityGroup operation.

Source§

impl Client

Source

pub fn create_multiplex(&self) -> CreateMultiplexFluentBuilder

Constructs a fluent builder for the CreateMultiplex operation.

Source§

impl Client

Source

pub fn create_multiplex_program(&self) -> CreateMultiplexProgramFluentBuilder

Constructs a fluent builder for the CreateMultiplexProgram operation.

Source§

impl Client

Source

pub fn create_network(&self) -> CreateNetworkFluentBuilder

Constructs a fluent builder for the CreateNetwork operation.

Source§

impl Client

Source

pub fn create_node(&self) -> CreateNodeFluentBuilder

Constructs a fluent builder for the CreateNode operation.

Source§

impl Client

Source

pub fn create_node_registration_script( &self, ) -> CreateNodeRegistrationScriptFluentBuilder

Constructs a fluent builder for the CreateNodeRegistrationScript operation.

Source§

impl Client

Source

pub fn create_partner_input(&self) -> CreatePartnerInputFluentBuilder

Constructs a fluent builder for the CreatePartnerInput operation.

Source§

impl Client

Source

pub fn create_sdi_source(&self) -> CreateSdiSourceFluentBuilder

Constructs a fluent builder for the CreateSdiSource operation.

Source§

impl Client

Source

pub fn create_signal_map(&self) -> CreateSignalMapFluentBuilder

Constructs a fluent builder for the CreateSignalMap operation.

Source§

impl Client

Source

pub fn create_tags(&self) -> CreateTagsFluentBuilder

Constructs a fluent builder for the CreateTags operation.

Source§

impl Client

Source

pub fn delete_channel(&self) -> DeleteChannelFluentBuilder

Constructs a fluent builder for the DeleteChannel operation.

Source§

impl Client

Source

pub fn delete_channel_placement_group( &self, ) -> DeleteChannelPlacementGroupFluentBuilder

Constructs a fluent builder for the DeleteChannelPlacementGroup operation.

Source§

impl Client

Source

pub fn delete_cloud_watch_alarm_template( &self, ) -> DeleteCloudWatchAlarmTemplateFluentBuilder

Constructs a fluent builder for the DeleteCloudWatchAlarmTemplate operation.

Source§

impl Client

Source

pub fn delete_cloud_watch_alarm_template_group( &self, ) -> DeleteCloudWatchAlarmTemplateGroupFluentBuilder

Constructs a fluent builder for the DeleteCloudWatchAlarmTemplateGroup operation.

Source§

impl Client

Source

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

Source§

impl Client

Source

pub fn delete_event_bridge_rule_template( &self, ) -> DeleteEventBridgeRuleTemplateFluentBuilder

Constructs a fluent builder for the DeleteEventBridgeRuleTemplate operation.

Source§

impl Client

Source

pub fn delete_event_bridge_rule_template_group( &self, ) -> DeleteEventBridgeRuleTemplateGroupFluentBuilder

Constructs a fluent builder for the DeleteEventBridgeRuleTemplateGroup operation.

Source§

impl Client

Source

pub fn delete_input(&self) -> DeleteInputFluentBuilder

Constructs a fluent builder for the DeleteInput operation.

Source§

impl Client

Source

pub fn delete_input_security_group( &self, ) -> DeleteInputSecurityGroupFluentBuilder

Constructs a fluent builder for the DeleteInputSecurityGroup operation.

Source§

impl Client

Source

pub fn delete_multiplex(&self) -> DeleteMultiplexFluentBuilder

Constructs a fluent builder for the DeleteMultiplex operation.

Source§

impl Client

Source

pub fn delete_multiplex_program(&self) -> DeleteMultiplexProgramFluentBuilder

Constructs a fluent builder for the DeleteMultiplexProgram operation.

Source§

impl Client

Source

pub fn delete_network(&self) -> DeleteNetworkFluentBuilder

Constructs a fluent builder for the DeleteNetwork operation.

Source§

impl Client

Source

pub fn delete_node(&self) -> DeleteNodeFluentBuilder

Constructs a fluent builder for the DeleteNode operation.

Source§

impl Client

Source

pub fn delete_reservation(&self) -> DeleteReservationFluentBuilder

Constructs a fluent builder for the DeleteReservation operation.

Source§

impl Client

Source

pub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder

Constructs a fluent builder for the DeleteSchedule operation.

Source§

impl Client

Source

pub fn delete_sdi_source(&self) -> DeleteSdiSourceFluentBuilder

Constructs a fluent builder for the DeleteSdiSource operation.

Source§

impl Client

Source

pub fn delete_signal_map(&self) -> DeleteSignalMapFluentBuilder

Constructs a fluent builder for the DeleteSignalMap operation.

Source§

impl Client

Source

pub fn delete_tags(&self) -> DeleteTagsFluentBuilder

Constructs a fluent builder for the DeleteTags operation.

Source§

impl Client

Source

pub fn describe_account_configuration( &self, ) -> DescribeAccountConfigurationFluentBuilder

Constructs a fluent builder for the DescribeAccountConfiguration operation.

Source§

impl Client

Source

pub fn describe_channel(&self) -> DescribeChannelFluentBuilder

Constructs a fluent builder for the DescribeChannel operation.

Source§

impl Client

Source

pub fn describe_channel_placement_group( &self, ) -> DescribeChannelPlacementGroupFluentBuilder

Constructs a fluent builder for the DescribeChannelPlacementGroup operation.

Source§

impl Client

Source

pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder

Constructs a fluent builder for the DescribeCluster operation.

Source§

impl Client

Source

pub fn describe_input(&self) -> DescribeInputFluentBuilder

Constructs a fluent builder for the DescribeInput operation.

Source§

impl Client

Source

pub fn describe_input_device(&self) -> DescribeInputDeviceFluentBuilder

Constructs a fluent builder for the DescribeInputDevice operation.

Source§

impl Client

Source

pub fn describe_input_device_thumbnail( &self, ) -> DescribeInputDeviceThumbnailFluentBuilder

Constructs a fluent builder for the DescribeInputDeviceThumbnail operation.

Source§

impl Client

Source

pub fn describe_input_security_group( &self, ) -> DescribeInputSecurityGroupFluentBuilder

Constructs a fluent builder for the DescribeInputSecurityGroup operation.

Source§

impl Client

Source

pub fn describe_multiplex(&self) -> DescribeMultiplexFluentBuilder

Constructs a fluent builder for the DescribeMultiplex operation.

Source§

impl Client

Source

pub fn describe_multiplex_program( &self, ) -> DescribeMultiplexProgramFluentBuilder

Constructs a fluent builder for the DescribeMultiplexProgram operation.

Source§

impl Client

Source

pub fn describe_network(&self) -> DescribeNetworkFluentBuilder

Constructs a fluent builder for the DescribeNetwork operation.

Source§

impl Client

Source

pub fn describe_node(&self) -> DescribeNodeFluentBuilder

Constructs a fluent builder for the DescribeNode operation.

Source§

impl Client

Source

pub fn describe_offering(&self) -> DescribeOfferingFluentBuilder

Constructs a fluent builder for the DescribeOffering operation.

Source§

impl Client

Source

pub fn describe_reservation(&self) -> DescribeReservationFluentBuilder

Constructs a fluent builder for the DescribeReservation operation.

Source§

impl Client

Source

pub fn describe_schedule(&self) -> DescribeScheduleFluentBuilder

Constructs a fluent builder for the DescribeSchedule operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_sdi_source(&self) -> DescribeSdiSourceFluentBuilder

Constructs a fluent builder for the DescribeSdiSource operation.

Source§

impl Client

Source

pub fn describe_thumbnails(&self) -> DescribeThumbnailsFluentBuilder

Constructs a fluent builder for the DescribeThumbnails operation.

Source§

impl Client

Source

pub fn get_cloud_watch_alarm_template( &self, ) -> GetCloudWatchAlarmTemplateFluentBuilder

Constructs a fluent builder for the GetCloudWatchAlarmTemplate operation.

Source§

impl Client

Source

pub fn get_cloud_watch_alarm_template_group( &self, ) -> GetCloudWatchAlarmTemplateGroupFluentBuilder

Constructs a fluent builder for the GetCloudWatchAlarmTemplateGroup operation.

Source§

impl Client

Source

pub fn get_event_bridge_rule_template( &self, ) -> GetEventBridgeRuleTemplateFluentBuilder

Constructs a fluent builder for the GetEventBridgeRuleTemplate operation.

Source§

impl Client

Source

pub fn get_event_bridge_rule_template_group( &self, ) -> GetEventBridgeRuleTemplateGroupFluentBuilder

Constructs a fluent builder for the GetEventBridgeRuleTemplateGroup operation.

Source§

impl Client

Source

pub fn get_signal_map(&self) -> GetSignalMapFluentBuilder

Constructs a fluent builder for the GetSignalMap operation.

Source§

impl Client

Source

pub fn list_channel_placement_groups( &self, ) -> ListChannelPlacementGroupsFluentBuilder

Constructs a fluent builder for the ListChannelPlacementGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_channels(&self) -> ListChannelsFluentBuilder

Constructs a fluent builder for the ListChannels operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

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().

Source§

impl Client

Source

pub fn list_cloud_watch_alarm_templates( &self, ) -> ListCloudWatchAlarmTemplatesFluentBuilder

Constructs a fluent builder for the ListCloudWatchAlarmTemplates operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_clusters(&self) -> ListClustersFluentBuilder

Constructs a fluent builder for the ListClusters operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

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().

Source§

impl Client

Source

pub fn list_event_bridge_rule_templates( &self, ) -> ListEventBridgeRuleTemplatesFluentBuilder

Constructs a fluent builder for the ListEventBridgeRuleTemplates operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_input_device_transfers( &self, ) -> ListInputDeviceTransfersFluentBuilder

Constructs a fluent builder for the ListInputDeviceTransfers operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_input_devices(&self) -> ListInputDevicesFluentBuilder

Constructs a fluent builder for the ListInputDevices operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_input_security_groups(&self) -> ListInputSecurityGroupsFluentBuilder

Constructs a fluent builder for the ListInputSecurityGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_inputs(&self) -> ListInputsFluentBuilder

Constructs a fluent builder for the ListInputs operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_multiplex_programs(&self) -> ListMultiplexProgramsFluentBuilder

Constructs a fluent builder for the ListMultiplexPrograms operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_multiplexes(&self) -> ListMultiplexesFluentBuilder

Constructs a fluent builder for the ListMultiplexes operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_networks(&self) -> ListNetworksFluentBuilder

Constructs a fluent builder for the ListNetworks operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_nodes(&self) -> ListNodesFluentBuilder

Constructs a fluent builder for the ListNodes operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_offerings(&self) -> ListOfferingsFluentBuilder

Constructs a fluent builder for the ListOfferings operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_reservations(&self) -> ListReservationsFluentBuilder

Constructs a fluent builder for the ListReservations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_sdi_sources(&self) -> ListSdiSourcesFluentBuilder

Constructs a fluent builder for the ListSdiSources operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_signal_maps(&self) -> ListSignalMapsFluentBuilder

Constructs a fluent builder for the ListSignalMaps operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_versions(&self) -> ListVersionsFluentBuilder

Constructs a fluent builder for the ListVersions operation.

Source§

impl Client

Source

pub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder

Constructs a fluent builder for the PurchaseOffering operation.

Source§

impl Client

Source

pub fn reboot_input_device(&self) -> RebootInputDeviceFluentBuilder

Constructs a fluent builder for the RebootInputDevice operation.

Source§

impl Client

Source

pub fn reject_input_device_transfer( &self, ) -> RejectInputDeviceTransferFluentBuilder

Constructs a fluent builder for the RejectInputDeviceTransfer operation.

Source§

impl Client

Source

pub fn restart_channel_pipelines(&self) -> RestartChannelPipelinesFluentBuilder

Constructs a fluent builder for the RestartChannelPipelines operation.

Source§

impl Client

Source

pub fn start_channel(&self) -> StartChannelFluentBuilder

Constructs a fluent builder for the StartChannel operation.

Source§

impl Client

Source

pub fn start_delete_monitor_deployment( &self, ) -> StartDeleteMonitorDeploymentFluentBuilder

Constructs a fluent builder for the StartDeleteMonitorDeployment operation.

Source§

impl Client

Source

pub fn start_input_device(&self) -> StartInputDeviceFluentBuilder

Constructs a fluent builder for the StartInputDevice operation.

Source§

impl Client

Source

pub fn start_input_device_maintenance_window( &self, ) -> StartInputDeviceMaintenanceWindowFluentBuilder

Constructs a fluent builder for the StartInputDeviceMaintenanceWindow operation.

Source§

impl Client

Source

pub fn start_monitor_deployment(&self) -> StartMonitorDeploymentFluentBuilder

Constructs a fluent builder for the StartMonitorDeployment operation.

Source§

impl Client

Source

pub fn start_multiplex(&self) -> StartMultiplexFluentBuilder

Constructs a fluent builder for the StartMultiplex operation.

Source§

impl Client

Source

pub fn start_update_signal_map(&self) -> StartUpdateSignalMapFluentBuilder

Constructs a fluent builder for the StartUpdateSignalMap operation.

Source§

impl Client

Source

pub fn stop_channel(&self) -> StopChannelFluentBuilder

Constructs a fluent builder for the StopChannel operation.

Source§

impl Client

Source

pub fn stop_input_device(&self) -> StopInputDeviceFluentBuilder

Constructs a fluent builder for the StopInputDevice operation.

Source§

impl Client

Source

pub fn stop_multiplex(&self) -> StopMultiplexFluentBuilder

Constructs a fluent builder for the StopMultiplex operation.

Source§

impl Client

Source

pub fn transfer_input_device(&self) -> TransferInputDeviceFluentBuilder

Constructs a fluent builder for the TransferInputDevice operation.

Source§

impl Client

Source

pub fn update_account_configuration( &self, ) -> UpdateAccountConfigurationFluentBuilder

Constructs a fluent builder for the UpdateAccountConfiguration operation.

Source§

impl Client

Source

pub fn update_channel(&self) -> UpdateChannelFluentBuilder

Constructs a fluent builder for the UpdateChannel operation.

Source§

impl Client

Source

pub fn update_channel_class(&self) -> UpdateChannelClassFluentBuilder

Constructs a fluent builder for the UpdateChannelClass operation.

Source§

impl Client

Source

pub fn update_channel_placement_group( &self, ) -> UpdateChannelPlacementGroupFluentBuilder

Constructs a fluent builder for the UpdateChannelPlacementGroup operation.

Source§

impl Client

Source

pub fn update_cloud_watch_alarm_template( &self, ) -> UpdateCloudWatchAlarmTemplateFluentBuilder

Constructs a fluent builder for the UpdateCloudWatchAlarmTemplate operation.

Source§

impl Client

Source

pub fn update_cloud_watch_alarm_template_group( &self, ) -> UpdateCloudWatchAlarmTemplateGroupFluentBuilder

Constructs a fluent builder for the UpdateCloudWatchAlarmTemplateGroup operation.

Source§

impl Client

Source

pub fn update_cluster(&self) -> UpdateClusterFluentBuilder

Constructs a fluent builder for the UpdateCluster operation.

Source§

impl Client

Source

pub fn update_event_bridge_rule_template( &self, ) -> UpdateEventBridgeRuleTemplateFluentBuilder

Constructs a fluent builder for the UpdateEventBridgeRuleTemplate operation.

Source§

impl Client

Source

pub fn update_event_bridge_rule_template_group( &self, ) -> UpdateEventBridgeRuleTemplateGroupFluentBuilder

Constructs a fluent builder for the UpdateEventBridgeRuleTemplateGroup operation.

Source§

impl Client

Source

pub fn update_input(&self) -> UpdateInputFluentBuilder

Constructs a fluent builder for the UpdateInput operation.

Source§

impl Client

Source

pub fn update_input_device(&self) -> UpdateInputDeviceFluentBuilder

Constructs a fluent builder for the UpdateInputDevice operation.

Source§

impl Client

Source

pub fn update_input_security_group( &self, ) -> UpdateInputSecurityGroupFluentBuilder

Constructs a fluent builder for the UpdateInputSecurityGroup operation.

Source§

impl Client

Source

pub fn update_multiplex(&self) -> UpdateMultiplexFluentBuilder

Constructs a fluent builder for the UpdateMultiplex operation.

Source§

impl Client

Source

pub fn update_multiplex_program(&self) -> UpdateMultiplexProgramFluentBuilder

Constructs a fluent builder for the UpdateMultiplexProgram operation.

Source§

impl Client

Source

pub fn update_network(&self) -> UpdateNetworkFluentBuilder

Constructs a fluent builder for the UpdateNetwork operation.

Source§

impl Client

Source

pub fn update_node(&self) -> UpdateNodeFluentBuilder

Constructs a fluent builder for the UpdateNode operation.

Source§

impl Client

Source

pub fn update_node_state(&self) -> UpdateNodeStateFluentBuilder

Constructs a fluent builder for the UpdateNodeState operation.

Source§

impl Client

Source

pub fn update_reservation(&self) -> UpdateReservationFluentBuilder

Constructs a fluent builder for the UpdateReservation operation.

Source§

impl Client

Source

pub fn update_sdi_source(&self) -> UpdateSdiSourceFluentBuilder

Constructs a fluent builder for the UpdateSdiSource operation.

Source§

impl Client

Source

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 and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Waiters for Client

Source§

fn wait_until_channel_created(&self) -> ChannelCreatedFluentBuilder

Wait until a channel has been created
Source§

fn wait_until_channel_deleted(&self) -> ChannelDeletedFluentBuilder

Wait until a channel has been deleted
Source§

fn wait_until_channel_running(&self) -> ChannelRunningFluentBuilder

Wait until a channel is running
Source§

fn wait_until_channel_stopped(&self) -> ChannelStoppedFluentBuilder

Wait until a channel has is stopped
Source§

fn wait_until_channel_placement_group_assigned( &self, ) -> ChannelPlacementGroupAssignedFluentBuilder

Wait until the channel placement group has been assigned
Source§

fn wait_until_channel_placement_group_deleted( &self, ) -> ChannelPlacementGroupDeletedFluentBuilder

Wait until the channel placement group has been deleted
Source§

fn wait_until_channel_placement_group_unassigned( &self, ) -> ChannelPlacementGroupUnassignedFluentBuilder

Wait until the channel placement group has been unassigned
Source§

fn wait_until_cluster_created(&self) -> ClusterCreatedFluentBuilder

Wait until a cluster has been created
Source§

fn wait_until_cluster_deleted(&self) -> ClusterDeletedFluentBuilder

Wait until a cluster has been deleted
Source§

fn wait_until_input_attached(&self) -> InputAttachedFluentBuilder

Wait until an input has been attached
Source§

fn wait_until_input_deleted(&self) -> InputDeletedFluentBuilder

Wait until an input has been deleted
Source§

fn wait_until_input_detached(&self) -> InputDetachedFluentBuilder

Wait until an input has been detached
Source§

fn wait_until_multiplex_created(&self) -> MultiplexCreatedFluentBuilder

Wait until a multiplex has been created
Source§

fn wait_until_multiplex_deleted(&self) -> MultiplexDeletedFluentBuilder

Wait until a multiplex has been deleted
Source§

fn wait_until_multiplex_running(&self) -> MultiplexRunningFluentBuilder

Wait until a multiplex is running
Source§

fn wait_until_multiplex_stopped(&self) -> MultiplexStoppedFluentBuilder

Wait until a multiplex has is stopped
Source§

fn wait_until_node_deregistered(&self) -> NodeDeregisteredFluentBuilder

Wait until a node has been deregistered
Source§

fn wait_until_node_registered(&self) -> NodeRegisteredFluentBuilder

Wait until a node has been registered
Source§

fn wait_until_signal_map_created(&self) -> SignalMapCreatedFluentBuilder

Wait until a signal map has been created
Source§

fn wait_until_signal_map_monitor_deleted( &self, ) -> SignalMapMonitorDeletedFluentBuilder

Wait until a signal map’s monitor has been deleted
Source§

fn wait_until_signal_map_monitor_deployed( &self, ) -> SignalMapMonitorDeployedFluentBuilder

Wait until a signal map’s monitor has been deployed
Source§

fn wait_until_signal_map_updated(&self) -> SignalMapUpdatedFluentBuilder

Wait until a signal map has been updated

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,