aws_sdk_amplify/client/
start_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 [`StartDeployment`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_id(impl Into<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::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::start_deployment::builders::StartDeploymentFluentBuilder::branch_name) / [`set_branch_name(Option<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::set_branch_name):<br>required: **true**<br><p>The name of the branch to use for the deployment job.</p><br>
8    ///   - [`job_id(impl Into<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::set_job_id):<br>required: **false**<br><p>The job ID for this deployment that is generated by the <code>CreateDeployment</code> request.</p><br>
9    ///   - [`source_url(impl Into<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::source_url) / [`set_source_url(Option<String>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::set_source_url):<br>required: **false**<br><p>The source URL for the deployment that is used when calling <code>StartDeployment</code> without <code>CreateDeployment</code>. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.</p><br>
10    ///   - [`source_url_type(SourceUrlType)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::source_url_type) / [`set_source_url_type(Option<SourceUrlType>)`](crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::set_source_url_type):<br>required: **false**<br><p>The type of source specified by the <code>sourceURL</code>. If the value is <code>ZIP</code>, the source is a .zip file. If the value is <code>BUCKET_PREFIX</code>, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is <code>ZIP</code>.</p><br>
11    /// - On success, responds with [`StartDeploymentOutput`](crate::operation::start_deployment::StartDeploymentOutput) with field(s):
12    ///   - [`job_summary(Option<JobSummary>)`](crate::operation::start_deployment::StartDeploymentOutput::job_summary): <p>The summary for the job.</p>
13    /// - On failure, responds with [`SdkError<StartDeploymentError>`](crate::operation::start_deployment::StartDeploymentError)
14    pub fn start_deployment(&self) -> crate::operation::start_deployment::builders::StartDeploymentFluentBuilder {
15        crate::operation::start_deployment::builders::StartDeploymentFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_amplify/client/start_deployment.rs

aws_sdk_amplify/client/
start_deployment.rs
