Amplify / Client / create_deployment

create_deployment#

Amplify.Client.create_deployment(**kwargs)#

Creates a deployment for a manually deployed Amplify 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

Request Syntax

response = client.create_deployment(
    appId='string',
    branchName='string',
    fileMap={
        'string': 'string'
    }
)
Parameters:

  • appId (string) –

    [REQUIRED]

    The unique ID for an Amplify app.

  • branchName (string) –

    [REQUIRED]

    The name of the branch to use for the job.

  • fileMap (dict) –

    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.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'fileUploadUrls': {
        'string': 'string'
    },
    'zipUploadUrl': 'string'
}

Response Structure

  • (dict) –

    The result structure for the create a new deployment request.

    • jobId (string) –

      The job ID for this deployment. will supply to start deployment api.

    • fileUploadUrls (dict) –

      When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.

      • (string) –

        • (string) –

    • zipUploadUrl (string) –

      When the fileMap argument is not provided in the request, this zipUploadUrl is returned.

Exceptions

  • Amplify.Client.exceptions.BadRequestException

  • Amplify.Client.exceptions.UnauthorizedException

  • Amplify.Client.exceptions.InternalFailureException

  • Amplify.Client.exceptions.LimitExceededException