amazonka-amplify-2.0: Amazon Amplify SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Amplify.CreateDeployment

Description

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.

Synopsis

Creating a Request

data CreateDeployment Source #

The request structure for the create a new deployment request.

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment' 

Fields

  • fileMap :: Maybe (HashMap Text Text)

    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.

  • appId :: Text

    The unique ID for an Amplify app.

  • branchName :: Text

    The name for the branch, for the job.

Instances

Instances details
ToJSON CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

ToHeaders CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

ToPath CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

ToQuery CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

AWSRequest CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Associated Types

type AWSResponse CreateDeployment #

Generic CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Associated Types

type Rep CreateDeployment :: Type -> Type #

Read CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Show CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

NFData CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Methods

rnf :: CreateDeployment -> () #

Eq CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Hashable CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

type AWSResponse CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

type Rep CreateDeployment Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.Amplify.CreateDeployment" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDeployment Source #

Create a value of CreateDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fileMap:CreateDeployment', createDeployment_fileMap - 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.

CreateDeployment, createDeployment_appId - The unique ID for an Amplify app.

CreateDeployment, createDeployment_branchName - The name for the branch, for the job.

Request Lenses

createDeployment_fileMap :: Lens' CreateDeployment (Maybe (HashMap Text Text)) Source #

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.

createDeployment_appId :: Lens' CreateDeployment Text Source #

The unique ID for an Amplify app.

createDeployment_branchName :: Lens' CreateDeployment Text Source #

The name for the branch, for the job.

Destructuring the Response

data CreateDeploymentResponse Source #

The result structure for the create a new deployment request.

See: newCreateDeploymentResponse smart constructor.

Constructors

CreateDeploymentResponse' 

Fields

  • jobId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

  • fileUploadUrls :: HashMap Text Text

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

  • zipUploadUrl :: Text

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

Instances

Instances details
Generic CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Associated Types

type Rep CreateDeploymentResponse :: Type -> Type #

Read CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Show CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

NFData CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

Eq CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

type Rep CreateDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.CreateDeployment

type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.Amplify.CreateDeployment" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateDeploymentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "fileUploadUrls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: S1 ('MetaSel ('Just "zipUploadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDeploymentResponse Source #

Create a value of CreateDeploymentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDeploymentResponse, createDeploymentResponse_jobId - The job ID for this deployment. will supply to start deployment api.

$sel:httpStatus:CreateDeploymentResponse', createDeploymentResponse_httpStatus - The response's http status code.

$sel:fileUploadUrls:CreateDeploymentResponse', createDeploymentResponse_fileUploadUrls - When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.

$sel:zipUploadUrl:CreateDeploymentResponse', createDeploymentResponse_zipUploadUrl - When the fileMap argument is not provided in the request, this zipUploadUrl is returned.

Response Lenses

createDeploymentResponse_jobId :: Lens' CreateDeploymentResponse (Maybe Text) Source #

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

createDeploymentResponse_fileUploadUrls :: Lens' CreateDeploymentResponse (HashMap Text Text) Source #

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

createDeploymentResponse_zipUploadUrl :: Lens' CreateDeploymentResponse Text Source #

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