Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.M2.CreateApplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new application with given parameters. Requires an existing runtime environment and application definition file.

Synopsis

data CreateApplication = CreateApplication' {
- clientToken :: Maybe Text
- description :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- definition :: Definition
- engineType :: EngineType
- name :: Text
}
newCreateApplication :: Definition -> EngineType -> Text -> CreateApplication
createApplication_clientToken :: Lens' CreateApplication (Maybe Text)
createApplication_description :: Lens' CreateApplication (Maybe Text)
createApplication_kmsKeyId :: Lens' CreateApplication (Maybe Text)
createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text))
createApplication_definition :: Lens' CreateApplication Definition
createApplication_engineType :: Lens' CreateApplication EngineType
createApplication_name :: Lens' CreateApplication Text
data CreateApplicationResponse = CreateApplicationResponse' {
- httpStatus :: Int
- applicationArn :: Text
- applicationId :: Text
- applicationVersion :: Natural
}
newCreateApplicationResponse :: Int -> Text -> Text -> Natural -> CreateApplicationResponse
createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int
createApplicationResponse_applicationArn :: Lens' CreateApplicationResponse Text
createApplicationResponse_applicationId :: Lens' CreateApplicationResponse Text
createApplicationResponse_applicationVersion :: Lens' CreateApplicationResponse Natural

Creating a Request

data CreateApplication Source #

See: newCreateApplication smart constructor.

Constructors

CreateApplication'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
description :: Maybe Text
The description of the application.
kmsKeyId :: Maybe Text
The identifier of a customer managed key.
tags :: Maybe (HashMap Text Text)
A list of tags to apply to the application.
definition :: Definition
The application definition for this application. You can specify either inline JSON or an S3 bucket location.
engineType :: EngineType
The type of the target platform for this application.
name :: Text
The unique identifier of the application.

Instances

Instances details

ToJSON CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods toJSON :: CreateApplication -> Value # toEncoding :: CreateApplication -> Encoding # toJSONList :: [CreateApplication] -> Value # toEncodingList :: [CreateApplication] -> Encoding #
ToHeaders CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods toHeaders :: CreateApplication -> [Header] #
ToPath CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods toPath :: CreateApplication -> ByteString #
ToQuery CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods toQuery :: CreateApplication -> QueryString #
AWSRequest CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Associated Types type AWSResponse CreateApplication # Methods request :: (Service -> Service) -> CreateApplication -> Request CreateApplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApplication))) #
Generic CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Associated Types type Rep CreateApplication :: Type -> Type # Methods from :: CreateApplication -> Rep CreateApplication x # to :: Rep CreateApplication x -> CreateApplication #
Read CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods readsPrec :: Int -> ReadS CreateApplication # readList :: ReadS [CreateApplication] # readPrec :: ReadPrec CreateApplication # readListPrec :: ReadPrec [CreateApplication] #
Show CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods showsPrec :: Int -> CreateApplication -> ShowS # show :: CreateApplication -> String # showList :: [CreateApplication] -> ShowS #
NFData CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods rnf :: CreateApplication -> () #
Eq CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods (==) :: CreateApplication -> CreateApplication -> Bool # (/=) :: CreateApplication -> CreateApplication -> Bool #
Hashable CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods hashWithSalt :: Int -> CreateApplication -> Int # hash :: CreateApplication -> Int #
type AWSResponse CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication type AWSResponse CreateApplication = CreateApplicationResponse
type Rep CreateApplication Source #
Instance details Defined in Amazonka.M2.CreateApplication type Rep CreateApplication = D1 ('MetaData "CreateApplication" "Amazonka.M2.CreateApplication" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "CreateApplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Definition)) :: (S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EngineType) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateApplication Source #

Arguments

:: Definition	`$sel:definition:CreateApplication'`
-> EngineType	`CreateApplication`
-> Text	`CreateApplication`
-> CreateApplication

Create a value of CreateApplication 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:clientToken:CreateApplication', createApplication_clientToken - Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

CreateApplication, createApplication_description - The description of the application.

$sel:kmsKeyId:CreateApplication', createApplication_kmsKeyId - The identifier of a customer managed key.

$sel:tags:CreateApplication', createApplication_tags - A list of tags to apply to the application.

$sel:definition:CreateApplication', createApplication_definition - The application definition for this application. You can specify either inline JSON or an S3 bucket location.

CreateApplication, createApplication_engineType - The type of the target platform for this application.

CreateApplication, createApplication_name - The unique identifier of the application.

Request Lenses

createApplication_clientToken :: Lens' CreateApplication (Maybe Text) Source #

Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

createApplication_description :: Lens' CreateApplication (Maybe Text) Source #

The description of the application.

createApplication_kmsKeyId :: Lens' CreateApplication (Maybe Text) Source #

The identifier of a customer managed key.

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #

A list of tags to apply to the application.

createApplication_definition :: Lens' CreateApplication Definition Source #

The application definition for this application. You can specify either inline JSON or an S3 bucket location.

createApplication_engineType :: Lens' CreateApplication EngineType Source #

The type of the target platform for this application.

createApplication_name :: Lens' CreateApplication Text Source #

The unique identifier of the application.

Destructuring the Response

data CreateApplicationResponse Source #

See: newCreateApplicationResponse smart constructor.

Constructors

CreateApplicationResponse'
Fields httpStatus :: Int The response's http status code. applicationArn :: Text The Amazon Resource Name (ARN) of the application. applicationId :: Text The unique application identifier. applicationVersion :: Natural The version number of the application.

Instances

Instances details

Generic CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication Associated Types type Rep CreateApplicationResponse :: Type -> Type # Methods from :: CreateApplicationResponse -> Rep CreateApplicationResponse x # to :: Rep CreateApplicationResponse x -> CreateApplicationResponse #
Read CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods readsPrec :: Int -> ReadS CreateApplicationResponse # readList :: ReadS [CreateApplicationResponse] # readPrec :: ReadPrec CreateApplicationResponse # readListPrec :: ReadPrec [CreateApplicationResponse] #
Show CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods showsPrec :: Int -> CreateApplicationResponse -> ShowS # show :: CreateApplicationResponse -> String # showList :: [CreateApplicationResponse] -> ShowS #
NFData CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods rnf :: CreateApplicationResponse -> () #
Eq CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication Methods (==) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool # (/=) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool #
type Rep CreateApplicationResponse Source #
Instance details Defined in Amazonka.M2.CreateApplication type Rep CreateApplicationResponse = D1 ('MetaData "CreateApplicationResponse" "Amazonka.M2.CreateApplication" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "CreateApplicationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "applicationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newCreateApplicationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateApplicationResponse'`
-> Text	`CreateApplicationResponse`
-> Text	`CreateApplicationResponse`
-> Natural	`CreateApplicationResponse`
-> CreateApplicationResponse

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

CreateApplicationResponse, createApplicationResponse_applicationArn - The Amazon Resource Name (ARN) of the application.

CreateApplicationResponse, createApplicationResponse_applicationId - The unique application identifier.

CreateApplicationResponse, createApplicationResponse_applicationVersion - The version number of the application.

Response Lenses

createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int Source #

The response's http status code.

createApplicationResponse_applicationArn :: Lens' CreateApplicationResponse Text Source #

The Amazon Resource Name (ARN) of the application.

createApplicationResponse_applicationId :: Lens' CreateApplicationResponse Text Source #

The unique application identifier.

createApplicationResponse_applicationVersion :: Lens' CreateApplicationResponse Natural Source #

The version number of the application.