libZSservicesZSamazonka-amplifyZSamazonka-amplify
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Amplify.StartDeployment

Description

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

Synopsis

Creating a Request

data StartDeployment Source #

The request structure for the start a deployment request.

See: newStartDeployment smart constructor.

Constructors

StartDeployment' 

Fields

  • jobId :: Maybe Text

    The job ID for this deployment, generated by the create deployment request.

  • sourceUrl :: Maybe Text

    The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.

  • appId :: Text

    The unique ID for an Amplify app.

  • branchName :: Text

    The name for the branch, for the job.

Instances

Instances details
Eq StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

(==) :: StartDeployment -> StartDeployment -> Bool #

(/=) :: StartDeployment -> StartDeployment -> Bool #

Read StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

readsPrec :: Int -> ReadS StartDeployment #

readList :: ReadS [StartDeployment] #

readPrec :: ReadPrec StartDeployment #

readListPrec :: ReadPrec [StartDeployment] #

Show StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

showsPrec :: Int -> StartDeployment -> ShowS #

show :: StartDeployment -> String #

showList :: [StartDeployment] -> ShowS #

Generic StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Associated Types

type Rep StartDeployment :: Type -> Type #

Methods

from :: StartDeployment -> Rep StartDeployment x #

to :: Rep StartDeployment x -> StartDeployment #

NFData StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

rnf :: StartDeployment -> () #

Hashable StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

hashWithSalt :: Int -> StartDeployment -> Int #

hash :: StartDeployment -> Int #

ToJSON StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

toJSON :: StartDeployment -> Value #

toEncoding :: StartDeployment -> Encoding #

toJSONList :: [StartDeployment] -> Value #

toEncodingList :: [StartDeployment] -> Encoding #

AWSRequest StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Associated Types

type AWSResponse StartDeployment #

Methods

request :: StartDeployment -> Request StartDeployment #

response :: MonadResource m => Logger -> Service -> Proxy StartDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDeployment))) #

ToHeaders StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

toHeaders :: StartDeployment -> [Header] #

ToPath StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

toPath :: StartDeployment -> ByteString #

ToQuery StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

toQuery :: StartDeployment -> QueryString #

type Rep StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

type Rep StartDeployment = D1 ('MetaData "StartDeployment" "Amazonka.Amplify.StartDeployment" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "StartDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartDeployment Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

type AWSResponse StartDeployment = StartDeploymentResponse

newStartDeployment Source #

Arguments

:: Text

$sel:appId:StartDeployment'

-> Text

$sel:branchName:StartDeployment'

-> StartDeployment 

Create a value of StartDeployment 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:StartDeployment', startDeployment_jobId - The job ID for this deployment, generated by the create deployment request.

$sel:sourceUrl:StartDeployment', startDeployment_sourceUrl - The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.

$sel:appId:StartDeployment', startDeployment_appId - The unique ID for an Amplify app.

$sel:branchName:StartDeployment', startDeployment_branchName - The name for the branch, for the job.

Request Lenses

startDeployment_jobId :: Lens' StartDeployment (Maybe Text) Source #

The job ID for this deployment, generated by the create deployment request.

startDeployment_sourceUrl :: Lens' StartDeployment (Maybe Text) Source #

The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.

startDeployment_appId :: Lens' StartDeployment Text Source #

The unique ID for an Amplify app.

startDeployment_branchName :: Lens' StartDeployment Text Source #

The name for the branch, for the job.

Destructuring the Response

data StartDeploymentResponse Source #

The result structure for the start a deployment request.

See: newStartDeploymentResponse smart constructor.

Constructors

StartDeploymentResponse' 

Fields

Instances

Instances details
Eq StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

(==) :: StartDeploymentResponse -> StartDeploymentResponse -> Bool #

(/=) :: StartDeploymentResponse -> StartDeploymentResponse -> Bool #

Read StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

readsPrec :: Int -> ReadS StartDeploymentResponse #

readList :: ReadS [StartDeploymentResponse] #

readPrec :: ReadPrec StartDeploymentResponse #

readListPrec :: ReadPrec [StartDeploymentResponse] #

Show StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

showsPrec :: Int -> StartDeploymentResponse -> ShowS #

show :: StartDeploymentResponse -> String #

showList :: [StartDeploymentResponse] -> ShowS #

Generic StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Associated Types

type Rep StartDeploymentResponse :: Type -> Type #

Methods

from :: StartDeploymentResponse -> Rep StartDeploymentResponse x #

to :: Rep StartDeploymentResponse x -> StartDeploymentResponse #

NFData StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

Methods

rnf :: StartDeploymentResponse -> () #

type Rep StartDeploymentResponse Source # 
Instance details

Defined in Amazonka.Amplify.StartDeployment

type Rep StartDeploymentResponse = D1 ('MetaData "StartDeploymentResponse" "Amazonka.Amplify.StartDeployment" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "StartDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobSummary)))

newStartDeploymentResponse Source #

Arguments

:: Int

$sel:httpStatus:StartDeploymentResponse'

-> JobSummary

$sel:jobSummary:StartDeploymentResponse'

-> StartDeploymentResponse 

Create a value of StartDeploymentResponse 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:httpStatus:StartDeploymentResponse', startDeploymentResponse_httpStatus - The response's http status code.

$sel:jobSummary:StartDeploymentResponse', startDeploymentResponse_jobSummary - The summary for the job.

Response Lenses

startDeploymentResponse_httpStatus :: Lens' StartDeploymentResponse Int Source #

The response's http status code.

startDeploymentResponse_jobSummary :: Lens' StartDeploymentResponse JobSummary Source #

The summary for the job.