Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Amplify.CreateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateDeployment = CreateDeployment' {
- fileMap :: Maybe (HashMap Text Text)
- appId :: Text
- branchName :: Text
}
newCreateDeployment :: Text -> Text -> CreateDeployment
createDeployment_fileMap :: Lens' CreateDeployment (Maybe (HashMap Text Text))
createDeployment_appId :: Lens' CreateDeployment Text
createDeployment_branchName :: Lens' CreateDeployment Text
data CreateDeploymentResponse = CreateDeploymentResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- fileUploadUrls :: HashMap Text Text
- zipUploadUrl :: Text
}
newCreateDeploymentResponse :: Int -> Text -> CreateDeploymentResponse
createDeploymentResponse_jobId :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int
createDeploymentResponse_fileUploadUrls :: Lens' CreateDeploymentResponse (HashMap Text Text)
createDeploymentResponse_zipUploadUrl :: Lens' CreateDeploymentResponse Text

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

Eq CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Read CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
Generic CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Associated Types type Rep CreateDeployment :: Type -> Type # Methods from :: CreateDeployment -> Rep CreateDeployment x # to :: Rep CreateDeployment x -> CreateDeployment #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods rnf :: CreateDeployment -> () #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Associated Types type AWSResponse CreateDeployment # Methods request :: CreateDeployment -> Request CreateDeployment # response :: MonadResource m => Logger -> Service -> Proxy CreateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeployment))) #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.Amplify.CreateDeployment" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" '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))))
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment type AWSResponse CreateDeployment = CreateDeploymentResponse

newCreateDeployment Source #

Arguments

:: Text	`$sel:appId:CreateDeployment'`
-> Text	`$sel:branchName:CreateDeployment'`
-> CreateDeployment

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.

$sel:appId:CreateDeployment', createDeployment_appId - The unique ID for an Amplify app.

$sel:branchName: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

Eq CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods (==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool # (/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool #
Read CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeploymentResponse # readList :: ReadS [CreateDeploymentResponse] # readPrec :: ReadPrec CreateDeploymentResponse # readListPrec :: ReadPrec [CreateDeploymentResponse] #
Show CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods showsPrec :: Int -> CreateDeploymentResponse -> ShowS # show :: CreateDeploymentResponse -> String # showList :: [CreateDeploymentResponse] -> ShowS #
Generic CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Associated Types type Rep CreateDeploymentResponse :: Type -> Type # Methods from :: CreateDeploymentResponse -> Rep CreateDeploymentResponse x # to :: Rep CreateDeploymentResponse x -> CreateDeploymentResponse #
NFData CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment Methods rnf :: CreateDeploymentResponse -> () #
type Rep CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Amplify.CreateDeployment type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.Amplify.CreateDeployment" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" '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 #

Arguments

:: Int	`$sel:httpStatus:CreateDeploymentResponse'`
-> Text	`$sel:zipUploadUrl:CreateDeploymentResponse'`
-> CreateDeploymentResponse

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:

$sel:jobId: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_httpStatus :: Lens' CreateDeploymentResponse Int Source #

The response's http status code.

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.