Struct aws_sdk_ivsrealtime::Client
source · pub struct Client { /* private fields */ }Expand description
Client for Amazon Interactive Video Service RealTime
Client for invoking operations on Amazon Interactive Video Service RealTime. Each operation on Amazon Interactive Video Service RealTime 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_ivsrealtime::Client::new(&config);Occasionally, SDKs may have additional service-specific that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Config struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ivsrealtime::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 CreateEncoderConfiguration operation has
a Client::create_encoder_configuration, 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.create_encoder_configuration()
.name("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_encoder_configuration(
&self
) -> CreateEncoderConfigurationFluentBuilder
pub fn create_encoder_configuration( &self ) -> CreateEncoderConfigurationFluentBuilder
Constructs a fluent builder for the CreateEncoderConfiguration operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: falseOptional name to identify the resource.
video(Video)/set_video(Option<Video>):
required: falseVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags attached to the resource. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources 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.
- On success, responds with
CreateEncoderConfigurationOutputwith field(s):encoder_configuration(Option<EncoderConfiguration>):The EncoderConfiguration that was created.
- On failure, responds with
SdkError<CreateEncoderConfigurationError>
source§impl Client
impl Client
sourcepub fn create_participant_token(&self) -> CreateParticipantTokenFluentBuilder
pub fn create_participant_token(&self) -> CreateParticipantTokenFluentBuilder
Constructs a fluent builder for the CreateParticipantToken operation.
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueARN of the stage to which this token is scoped.
duration(i32)/set_duration(Option<i32>):
required: falseDuration (in minutes), after which the token expires. Default: 720 (12 hours).
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseName that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
attributes(impl Into<String>, impl Into<String>)/set_attributes(Option<HashMap::<String, String>>):
required: falseApplication-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
capabilities(ParticipantTokenCapability)/set_capabilities(Option<Vec::<ParticipantTokenCapability>>):
required: falseSet of capabilities that the user is allowed to perform in the stage. Default:
PUBLISH, SUBSCRIBE.
- On success, responds with
CreateParticipantTokenOutputwith field(s):participant_token(Option<ParticipantToken>):The participant token that was created.
- On failure, responds with
SdkError<CreateParticipantTokenError>
source§impl Client
impl Client
sourcepub fn create_stage(&self) -> CreateStageFluentBuilder
pub fn create_stage(&self) -> CreateStageFluentBuilder
Constructs a fluent builder for the CreateStage operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: falseOptional name that can be specified for the stage being created.
participant_token_configurations(ParticipantTokenConfiguration)/set_participant_token_configurations(Option<Vec::<ParticipantTokenConfiguration>>):
required: falseArray of participant token configuration objects to attach to the new stage.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags attached to the resource. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources 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.
- On success, responds with
CreateStageOutputwith field(s):stage(Option<Stage>):The stage that was created.
participant_tokens(Option<Vec::<ParticipantToken>>):Participant tokens attached to the stage. These correspond to the
participantsin the request.
- On failure, responds with
SdkError<CreateStageError>
source§impl Client
impl Client
sourcepub fn create_storage_configuration(
&self
) -> CreateStorageConfigurationFluentBuilder
pub fn create_storage_configuration( &self ) -> CreateStorageConfigurationFluentBuilder
Constructs a fluent builder for the CreateStorageConfiguration operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: falseStorage configuration name. The value does not need to be unique.
s3(S3StorageConfiguration)/set_s3(Option<S3StorageConfiguration>):
required: trueA complex type that contains a storage configuration for where recorded video will be stored.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags attached to the resource. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources 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.
- On success, responds with
CreateStorageConfigurationOutputwith field(s):storage_configuration(Option<StorageConfiguration>):The StorageConfiguration that was created.
- On failure, responds with
SdkError<CreateStorageConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_encoder_configuration(
&self
) -> DeleteEncoderConfigurationFluentBuilder
pub fn delete_encoder_configuration( &self ) -> DeleteEncoderConfigurationFluentBuilder
Constructs a fluent builder for the DeleteEncoderConfiguration operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the EncoderConfiguration.
- On success, responds with
DeleteEncoderConfigurationOutput - On failure, responds with
SdkError<DeleteEncoderConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_stage(&self) -> DeleteStageFluentBuilder
pub fn delete_stage(&self) -> DeleteStageFluentBuilder
Constructs a fluent builder for the DeleteStage operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the stage to be deleted.
- On success, responds with
DeleteStageOutput - On failure, responds with
SdkError<DeleteStageError>
source§impl Client
impl Client
sourcepub fn delete_storage_configuration(
&self
) -> DeleteStorageConfigurationFluentBuilder
pub fn delete_storage_configuration( &self ) -> DeleteStorageConfigurationFluentBuilder
Constructs a fluent builder for the DeleteStorageConfiguration operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the storage configuration to be deleted.
- On success, responds with
DeleteStorageConfigurationOutput - On failure, responds with
SdkError<DeleteStorageConfigurationError>
source§impl Client
impl Client
sourcepub fn disconnect_participant(&self) -> DisconnectParticipantFluentBuilder
pub fn disconnect_participant(&self) -> DisconnectParticipantFluentBuilder
Constructs a fluent builder for the DisconnectParticipant operation.
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueARN of the stage to which the participant is attached.
participant_id(impl Into<String>)/set_participant_id(Option<String>):
required: trueIdentifier of the participant to be disconnected. This is assigned by IVS and returned by
CreateParticipantToken.reason(impl Into<String>)/set_reason(Option<String>):
required: falseDescription of why this participant is being disconnected.
- On success, responds with
DisconnectParticipantOutput - On failure, responds with
SdkError<DisconnectParticipantError>
source§impl Client
impl Client
sourcepub fn get_composition(&self) -> GetCompositionFluentBuilder
pub fn get_composition(&self) -> GetCompositionFluentBuilder
Constructs a fluent builder for the GetComposition operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the Composition resource.
- On success, responds with
GetCompositionOutputwith field(s):composition(Option<Composition>):The Composition that was returned.
- On failure, responds with
SdkError<GetCompositionError>
source§impl Client
impl Client
sourcepub fn get_encoder_configuration(&self) -> GetEncoderConfigurationFluentBuilder
pub fn get_encoder_configuration(&self) -> GetEncoderConfigurationFluentBuilder
Constructs a fluent builder for the GetEncoderConfiguration operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the EncoderConfiguration resource.
- On success, responds with
GetEncoderConfigurationOutputwith field(s):encoder_configuration(Option<EncoderConfiguration>):The EncoderConfiguration that was returned.
- On failure, responds with
SdkError<GetEncoderConfigurationError>
source§impl Client
impl Client
sourcepub fn get_participant(&self) -> GetParticipantFluentBuilder
pub fn get_participant(&self) -> GetParticipantFluentBuilder
Constructs a fluent builder for the GetParticipant operation.
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueStage ARN.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueID of a session within the stage.
participant_id(impl Into<String>)/set_participant_id(Option<String>):
required: trueUnique identifier for the participant. This is assigned by IVS and returned by
CreateParticipantToken.
- On success, responds with
GetParticipantOutputwith field(s):participant(Option<Participant>):The participant that is returned.
- On failure, responds with
SdkError<GetParticipantError>
source§impl Client
impl Client
sourcepub fn get_stage(&self) -> GetStageFluentBuilder
pub fn get_stage(&self) -> GetStageFluentBuilder
Constructs a fluent builder for the GetStage operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the stage for which the information is to be retrieved.
- On success, responds with
GetStageOutputwith field(s):stage(Option<Stage>):The stage that is returned.
- On failure, responds with
SdkError<GetStageError>
source§impl Client
impl Client
sourcepub fn get_stage_session(&self) -> GetStageSessionFluentBuilder
pub fn get_stage_session(&self) -> GetStageSessionFluentBuilder
Constructs a fluent builder for the GetStageSession operation.
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueARN of the stage for which the information is to be retrieved.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueID of a session within the stage.
- On success, responds with
GetStageSessionOutputwith field(s):stage_session(Option<StageSession>):The stage session that is returned.
- On failure, responds with
SdkError<GetStageSessionError>
source§impl Client
impl Client
sourcepub fn get_storage_configuration(&self) -> GetStorageConfigurationFluentBuilder
pub fn get_storage_configuration(&self) -> GetStorageConfigurationFluentBuilder
Constructs a fluent builder for the GetStorageConfiguration operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the storage configuration to be retrieved.
- On success, responds with
GetStorageConfigurationOutputwith field(s):storage_configuration(Option<StorageConfiguration>):The StorageConfiguration that was returned.
- On failure, responds with
SdkError<GetStorageConfigurationError>
source§impl Client
impl Client
sourcepub fn list_compositions(&self) -> ListCompositionsFluentBuilder
pub fn list_compositions(&self) -> ListCompositionsFluentBuilder
Constructs a fluent builder for the ListCompositions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
filter_by_stage_arn(impl Into<String>)/set_filter_by_stage_arn(Option<String>):
required: falseFilters the Composition list to match the specified Stage ARN.
filter_by_encoder_configuration_arn(impl Into<String>)/set_filter_by_encoder_configuration_arn(Option<String>):
required: falseFilters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first Composition to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 100.
- On success, responds with
ListCompositionsOutputwith field(s):compositions(Vec::<CompositionSummary>):List of the matching Compositions (summary information only).
next_token(Option<String>):If there are more compositions than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListCompositionsError>
source§impl Client
impl Client
sourcepub fn list_encoder_configurations(
&self
) -> ListEncoderConfigurationsFluentBuilder
pub fn list_encoder_configurations( &self ) -> ListEncoderConfigurationsFluentBuilder
Constructs a fluent builder for the ListEncoderConfigurations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first encoder configuration to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 100.
- On success, responds with
ListEncoderConfigurationsOutputwith field(s):encoder_configurations(Vec::<EncoderConfigurationSummary>):List of the matching EncoderConfigurations (summary information only).
next_token(Option<String>):If there are more encoder configurations than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListEncoderConfigurationsError>
source§impl Client
impl Client
sourcepub fn list_participant_events(&self) -> ListParticipantEventsFluentBuilder
pub fn list_participant_events(&self) -> ListParticipantEventsFluentBuilder
Constructs a fluent builder for the ListParticipantEvents operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueStage ARN.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueID of a session within the stage.
participant_id(impl Into<String>)/set_participant_id(Option<String>):
required: trueUnique identifier for this participant. This is assigned by IVS and returned by
CreateParticipantToken.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first participant event to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 50.
- On success, responds with
ListParticipantEventsOutputwith field(s):events(Vec::<Event>):List of the matching events.
next_token(Option<String>):If there are more events than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListParticipantEventsError>
source§impl Client
impl Client
sourcepub fn list_participants(&self) -> ListParticipantsFluentBuilder
pub fn list_participants(&self) -> ListParticipantsFluentBuilder
Constructs a fluent builder for the ListParticipants operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueStage ARN.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueID of the session within the stage.
filter_by_user_id(impl Into<String>)/set_filter_by_user_id(Option<String>):
required: falseFilters the response list to match the specified user ID. Only one of
filterByUserId,filterByPublished, orfilterByStatecan be provided per request. AuserIdis a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.filter_by_published(bool)/set_filter_by_published(Option<bool>):
required: falseFilters the response list to only show participants who published during the stage session. Only one of
filterByUserId,filterByPublished, orfilterByStatecan be provided per request.filter_by_state(ParticipantState)/set_filter_by_state(Option<ParticipantState>):
required: falseFilters the response list to only show participants in the specified state. Only one of
filterByUserId,filterByPublished, orfilterByStatecan be provided per request.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first participant to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 50.
- On success, responds with
ListParticipantsOutputwith field(s):participants(Vec::<ParticipantSummary>):List of the matching participants (summary information only).
next_token(Option<String>):If there are more participants than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListParticipantsError>
source§impl Client
impl Client
sourcepub fn list_stage_sessions(&self) -> ListStageSessionsFluentBuilder
pub fn list_stage_sessions(&self) -> ListStageSessionsFluentBuilder
Constructs a fluent builder for the ListStageSessions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueStage ARN.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first stage session to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 50.
- On success, responds with
ListStageSessionsOutputwith field(s):stage_sessions(Vec::<StageSessionSummary>):List of matching stage sessions.
next_token(Option<String>):If there are more stage sessions than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListStageSessionsError>
source§impl Client
impl Client
sourcepub fn list_stages(&self) -> ListStagesFluentBuilder
pub fn list_stages(&self) -> ListStagesFluentBuilder
Constructs a fluent builder for the ListStages operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first stage to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return. Default: 50.
- On success, responds with
ListStagesOutputwith field(s):stages(Vec::<StageSummary>):List of the matching stages (summary information only).
next_token(Option<String>):If there are more stages than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListStagesError>
source§impl Client
impl Client
sourcepub fn list_storage_configurations(
&self
) -> ListStorageConfigurationsFluentBuilder
pub fn list_storage_configurations( &self ) -> ListStorageConfigurationsFluentBuilder
Constructs a fluent builder for the ListStorageConfigurations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe first storage configuration to retrieve. This is used for pagination; see the
nextTokenresponse field.max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
- On success, responds with
ListStorageConfigurationsOutputwith field(s):storage_configurations(Vec::<StorageConfigurationSummary>):List of the matching storage configurations.
next_token(Option<String>):If there are more storage configurations than
maxResults, usenextTokenin the request to get the next set.
- On failure, responds with
SdkError<ListStorageConfigurationsError>
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: trueThe ARN of the resource to be retrieved. The ARN must be URL-encoded.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(HashMap::<String, String>):Tags attached to the resource. Array of maps, each of the form
string:string (key:value).
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_composition(&self) -> StartCompositionFluentBuilder
pub fn start_composition(&self) -> StartCompositionFluentBuilder
Constructs a fluent builder for the StartComposition operation.
- The fluent builder is configurable:
stage_arn(impl Into<String>)/set_stage_arn(Option<String>):
required: trueARN of the stage to be used for compositing.
idempotency_token(impl Into<String>)/set_idempotency_token(Option<String>):
required: falseIdempotency token.
layout(LayoutConfiguration)/set_layout(Option<LayoutConfiguration>):
required: falseLayout object to configure composition parameters.
destinations(DestinationConfiguration)/set_destinations(Option<Vec::<DestinationConfiguration>>):
required: trueArray of destination configuration.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags attached to the resource. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources 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.
- On success, responds with
StartCompositionOutputwith field(s):composition(Option<Composition>):The Composition that was created.
- On failure, responds with
SdkError<StartCompositionError>
source§impl Client
impl Client
sourcepub fn stop_composition(&self) -> StopCompositionFluentBuilder
pub fn stop_composition(&self) -> StopCompositionFluentBuilder
Constructs a fluent builder for the StopComposition operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the Composition.
- On success, responds with
StopCompositionOutput - On failure, responds with
SdkError<StopCompositionError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe ARN of the resource to be tagged. The ARN must be URL-encoded.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueArray of tags to be added or updated. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints beyond what is documented there.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe ARN of the resource to be untagged. The ARN must be URL-encoded.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueArray of tags to be removed. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints beyond what is documented there.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_stage(&self) -> UpdateStageFluentBuilder
pub fn update_stage(&self) -> UpdateStageFluentBuilder
Constructs a fluent builder for the UpdateStage operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: trueARN of the stage to be updated.
name(impl Into<String>)/set_name(Option<String>):
required: falseName of the stage to be updated.
- On success, responds with
UpdateStageOutputwith field(s):stage(Option<Stage>):The updated stage.
- On failure, responds with
SdkError<UpdateStageError>
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis 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_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.