aws_sdk_amplify/client/
create_deployment.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 [`CreateDeployment`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_id(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for an Amplify app.</p><br>
7    ///   - [`branch_name(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::branch_name) / [`set_branch_name(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_branch_name):<br>required: **true**<br><p>The name of the branch to use for the job.</p><br>
8    ///   - [`file_map(impl Into<String>, impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::file_map) / [`set_file_map(Option<HashMap::<String, String>>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_file_map):<br>required: **false**<br><p>An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.</p><br>
9    /// - On success, responds with [`CreateDeploymentOutput`](crate::operation::create_deployment::CreateDeploymentOutput) with field(s):
10    ///   - [`job_id(Option<String>)`](crate::operation::create_deployment::CreateDeploymentOutput::job_id): <p>The job ID for this deployment. will supply to start deployment api.</p>
11    ///   - [`file_upload_urls(HashMap::<String, String>)`](crate::operation::create_deployment::CreateDeploymentOutput::file_upload_urls): <p>When the <code>fileMap</code> argument is provided in the request, <code>fileUploadUrls</code> will contain a map of file names to upload URLs.</p>
12    ///   - [`zip_upload_url(String)`](crate::operation::create_deployment::CreateDeploymentOutput::zip_upload_url): <p>When the <code>fileMap</code> argument is not provided in the request, this <code>zipUploadUrl</code> is returned.</p>
13    /// - On failure, responds with [`SdkError<CreateDeploymentError>`](crate::operation::create_deployment::CreateDeploymentError)
14    pub fn create_deployment(&self) -> crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder {
15        crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::new(self.handle.clone())
16    }
17}