amazonka-sms-2.0: gen/Amazonka/SMS/CreateApp.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.SMS.CreateApp
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates an application. An application consists of one or more server
-- groups. Each server group contain one or more servers.
module Amazonka.SMS.CreateApp
( -- * Creating a Request
CreateApp (..),
newCreateApp,
-- * Request Lenses
createApp_clientToken,
createApp_description,
createApp_name,
createApp_roleName,
createApp_serverGroups,
createApp_tags,
-- * Destructuring the Response
CreateAppResponse (..),
newCreateAppResponse,
-- * Response Lenses
createAppResponse_appSummary,
createAppResponse_serverGroups,
createAppResponse_tags,
createAppResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SMS.Types
-- | /See:/ 'newCreateApp' smart constructor.
data CreateApp = CreateApp'
{ -- | A unique, case-sensitive identifier that you provide to ensure the
-- idempotency of application creation.
clientToken :: Prelude.Maybe Prelude.Text,
-- | The description of the new application
description :: Prelude.Maybe Prelude.Text,
-- | The name of the new application.
name :: Prelude.Maybe Prelude.Text,
-- | The name of the service role in the customer\'s account to be used by
-- Server Migration Service.
roleName :: Prelude.Maybe Prelude.Text,
-- | The server groups to include in the application.
serverGroups :: Prelude.Maybe [ServerGroup],
-- | The tags to be associated with the application.
tags :: Prelude.Maybe [Tag]
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateApp' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'clientToken', 'createApp_clientToken' - A unique, case-sensitive identifier that you provide to ensure the
-- idempotency of application creation.
--
-- 'description', 'createApp_description' - The description of the new application
--
-- 'name', 'createApp_name' - The name of the new application.
--
-- 'roleName', 'createApp_roleName' - The name of the service role in the customer\'s account to be used by
-- Server Migration Service.
--
-- 'serverGroups', 'createApp_serverGroups' - The server groups to include in the application.
--
-- 'tags', 'createApp_tags' - The tags to be associated with the application.
newCreateApp ::
CreateApp
newCreateApp =
CreateApp'
{ clientToken = Prelude.Nothing,
description = Prelude.Nothing,
name = Prelude.Nothing,
roleName = Prelude.Nothing,
serverGroups = Prelude.Nothing,
tags = Prelude.Nothing
}
-- | A unique, case-sensitive identifier that you provide to ensure the
-- idempotency of application creation.
createApp_clientToken :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text)
createApp_clientToken = Lens.lens (\CreateApp' {clientToken} -> clientToken) (\s@CreateApp' {} a -> s {clientToken = a} :: CreateApp)
-- | The description of the new application
createApp_description :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text)
createApp_description = Lens.lens (\CreateApp' {description} -> description) (\s@CreateApp' {} a -> s {description = a} :: CreateApp)
-- | The name of the new application.
createApp_name :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text)
createApp_name = Lens.lens (\CreateApp' {name} -> name) (\s@CreateApp' {} a -> s {name = a} :: CreateApp)
-- | The name of the service role in the customer\'s account to be used by
-- Server Migration Service.
createApp_roleName :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text)
createApp_roleName = Lens.lens (\CreateApp' {roleName} -> roleName) (\s@CreateApp' {} a -> s {roleName = a} :: CreateApp)
-- | The server groups to include in the application.
createApp_serverGroups :: Lens.Lens' CreateApp (Prelude.Maybe [ServerGroup])
createApp_serverGroups = Lens.lens (\CreateApp' {serverGroups} -> serverGroups) (\s@CreateApp' {} a -> s {serverGroups = a} :: CreateApp) Prelude.. Lens.mapping Lens.coerced
-- | The tags to be associated with the application.
createApp_tags :: Lens.Lens' CreateApp (Prelude.Maybe [Tag])
createApp_tags = Lens.lens (\CreateApp' {tags} -> tags) (\s@CreateApp' {} a -> s {tags = a} :: CreateApp) Prelude.. Lens.mapping Lens.coerced
instance Core.AWSRequest CreateApp where
type AWSResponse CreateApp = CreateAppResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
CreateAppResponse'
Prelude.<$> (x Data..?> "appSummary")
Prelude.<*> (x Data..?> "serverGroups" Core..!@ Prelude.mempty)
Prelude.<*> (x Data..?> "tags" Core..!@ Prelude.mempty)
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable CreateApp where
hashWithSalt _salt CreateApp' {..} =
_salt
`Prelude.hashWithSalt` clientToken
`Prelude.hashWithSalt` description
`Prelude.hashWithSalt` name
`Prelude.hashWithSalt` roleName
`Prelude.hashWithSalt` serverGroups
`Prelude.hashWithSalt` tags
instance Prelude.NFData CreateApp where
rnf CreateApp' {..} =
Prelude.rnf clientToken
`Prelude.seq` Prelude.rnf description
`Prelude.seq` Prelude.rnf name
`Prelude.seq` Prelude.rnf roleName
`Prelude.seq` Prelude.rnf serverGroups
`Prelude.seq` Prelude.rnf tags
instance Data.ToHeaders CreateApp where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "AWSServerMigrationService_V2016_10_24.CreateApp" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON CreateApp where
toJSON CreateApp' {..} =
Data.object
( Prelude.catMaybes
[ ("clientToken" Data..=) Prelude.<$> clientToken,
("description" Data..=) Prelude.<$> description,
("name" Data..=) Prelude.<$> name,
("roleName" Data..=) Prelude.<$> roleName,
("serverGroups" Data..=) Prelude.<$> serverGroups,
("tags" Data..=) Prelude.<$> tags
]
)
instance Data.ToPath CreateApp where
toPath = Prelude.const "/"
instance Data.ToQuery CreateApp where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newCreateAppResponse' smart constructor.
data CreateAppResponse = CreateAppResponse'
{ -- | A summary description of the application.
appSummary :: Prelude.Maybe AppSummary,
-- | The server groups included in the application.
serverGroups :: Prelude.Maybe [ServerGroup],
-- | The tags associated with the application.
tags :: Prelude.Maybe [Tag],
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateAppResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'appSummary', 'createAppResponse_appSummary' - A summary description of the application.
--
-- 'serverGroups', 'createAppResponse_serverGroups' - The server groups included in the application.
--
-- 'tags', 'createAppResponse_tags' - The tags associated with the application.
--
-- 'httpStatus', 'createAppResponse_httpStatus' - The response's http status code.
newCreateAppResponse ::
-- | 'httpStatus'
Prelude.Int ->
CreateAppResponse
newCreateAppResponse pHttpStatus_ =
CreateAppResponse'
{ appSummary = Prelude.Nothing,
serverGroups = Prelude.Nothing,
tags = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | A summary description of the application.
createAppResponse_appSummary :: Lens.Lens' CreateAppResponse (Prelude.Maybe AppSummary)
createAppResponse_appSummary = Lens.lens (\CreateAppResponse' {appSummary} -> appSummary) (\s@CreateAppResponse' {} a -> s {appSummary = a} :: CreateAppResponse)
-- | The server groups included in the application.
createAppResponse_serverGroups :: Lens.Lens' CreateAppResponse (Prelude.Maybe [ServerGroup])
createAppResponse_serverGroups = Lens.lens (\CreateAppResponse' {serverGroups} -> serverGroups) (\s@CreateAppResponse' {} a -> s {serverGroups = a} :: CreateAppResponse) Prelude.. Lens.mapping Lens.coerced
-- | The tags associated with the application.
createAppResponse_tags :: Lens.Lens' CreateAppResponse (Prelude.Maybe [Tag])
createAppResponse_tags = Lens.lens (\CreateAppResponse' {tags} -> tags) (\s@CreateAppResponse' {} a -> s {tags = a} :: CreateAppResponse) Prelude.. Lens.mapping Lens.coerced
-- | The response's http status code.
createAppResponse_httpStatus :: Lens.Lens' CreateAppResponse Prelude.Int
createAppResponse_httpStatus = Lens.lens (\CreateAppResponse' {httpStatus} -> httpStatus) (\s@CreateAppResponse' {} a -> s {httpStatus = a} :: CreateAppResponse)
instance Prelude.NFData CreateAppResponse where
rnf CreateAppResponse' {..} =
Prelude.rnf appSummary
`Prelude.seq` Prelude.rnf serverGroups
`Prelude.seq` Prelude.rnf tags
`Prelude.seq` Prelude.rnf httpStatus