aws_sdk_gamelift/client/update_script.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 [`UpdateScript`](crate::operation::update_script::builders::UpdateScriptFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`script_id(impl Into<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::script_id) / [`set_script_id(Option<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::set_script_id):<br>required: **true**<br><p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p><br>
7 /// - [`name(impl Into<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::set_name):<br>required: **false**<br><p>A descriptive label that is associated with a script. Script names do not need to be unique.</p><br>
8 /// - [`version(impl Into<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::version) / [`set_version(Option<String>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::set_version):<br>required: **false**<br><p>Version information that is associated with a build or script. Version strings do not need to be unique.</p><br>
9 /// - [`storage_location(S3Location)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::storage_location) / [`set_storage_location(Option<S3Location>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::set_storage_location):<br>required: **false**<br><p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version.</p><br>
10 /// - [`zip_file(Blob)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::zip_file) / [`set_zip_file(Option<Blob>)`](crate::operation::update_script::builders::UpdateScriptFluentBuilder::set_zip_file):<br>required: **false**<br><p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p><br>
11 /// - On success, responds with [`UpdateScriptOutput`](crate::operation::update_script::UpdateScriptOutput) with field(s):
12 /// - [`script(Option<Script>)`](crate::operation::update_script::UpdateScriptOutput::script): <p>The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift Servers service.</p>
13 /// - On failure, responds with [`SdkError<UpdateScriptError>`](crate::operation::update_script::UpdateScriptError)
14 pub fn update_script(&self) -> crate::operation::update_script::builders::UpdateScriptFluentBuilder {
15 crate::operation::update_script::builders::UpdateScriptFluentBuilder::new(self.handle.clone())
16 }
17}