:doc:`Amplify <../../amplify>` / Client / start_deployment

****************
start_deployment
****************



.. py:method:: Amplify.Client.start_deployment(**kwargs)

  

  Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

   

  The maximum duration between the ``CreateDeployment`` call and the ``StartDeployment`` call cannot exceed 8 hours. If the duration exceeds 8 hours, the ``StartDeployment`` call and the associated ``Job`` will fail.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeployment>`_  


  **Request Syntax**
  ::

    response = client.start_deployment(
        appId='string',
        branchName='string',
        jobId='string',
        sourceUrl='string',
        sourceUrlType='ZIP'|'BUCKET_PREFIX'
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique ID for an Amplify app.

    

  
  :type branchName: string
  :param branchName: **[REQUIRED]** 

    The name of the branch to use for the deployment job.

    

  
  :type jobId: string
  :param jobId: 

    The job ID for this deployment that is generated by the ``CreateDeployment`` request.

    

  
  :type sourceUrl: string
  :param sourceUrl: 

    The source URL for the deployment that is used when calling ``StartDeployment`` without ``CreateDeployment``. 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.

    

  
  :type sourceUrlType: string
  :param sourceUrlType: 

    The type of source specified by the ``sourceURL``. If the value is ``ZIP``, the source is a .zip file. If the value is ``BUCKET_PREFIX``, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ``ZIP``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'jobSummary': {
              'jobArn': 'string',
              'jobId': 'string',
              'commitId': 'string',
              'commitMessage': 'string',
              'commitTime': datetime(2015, 1, 1),
              'startTime': datetime(2015, 1, 1),
              'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
              'endTime': datetime(2015, 1, 1),
              'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
              'sourceUrl': 'string',
              'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result structure for the start a deployment request.

      
      

      - **jobSummary** *(dict) --* 

        The summary for the job.

        
        

        - **jobArn** *(string) --* 

          The Amazon Resource Name (ARN) for the job.

          
        

        - **jobId** *(string) --* 

          The unique ID for the job.

          
        

        - **commitId** *(string) --* 

          The commit ID from a third-party repository provider for the job.

          
        

        - **commitMessage** *(string) --* 

          The commit message from a third-party repository provider for the job.

          
        

        - **commitTime** *(datetime) --* 

          The commit date and time for the job.

          
        

        - **startTime** *(datetime) --* 

          The start date and time for the job.

          
        

        - **status** *(string) --* 

          The current status for the job.

          
        

        - **endTime** *(datetime) --* 

          The end date and time for the job.

          
        

        - **jobType** *(string) --* 

          The type for the job. If the value is ``RELEASE``, the job was manually released from its source by using the ``StartJob`` API. This value is available only for apps that are connected to a repository.

           

          If the value is ``RETRY``, the job was manually retried using the ``StartJob`` API. If the value is ``WEB_HOOK``, the job was automatically triggered by webhooks. If the value is ``MANUAL``, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

          
        

        - **sourceUrl** *(string) --* 

          The source URL for the files to deploy. 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.

          
        

        - **sourceUrlType** *(string) --* 

          The type of source specified by the ``sourceURL``. If the value is ``ZIP``, the source is a .zip file. If the value is ``BUCKET_PREFIX``, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ``ZIP``.

          
    
  
  **Exceptions**
  
  *   :py:class:`Amplify.Client.exceptions.BadRequestException`

  
  *   :py:class:`Amplify.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`Amplify.Client.exceptions.InternalFailureException`

  
  *   :py:class:`Amplify.Client.exceptions.NotFoundException`

  
  *   :py:class:`Amplify.Client.exceptions.LimitExceededException`

  