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.WellArchitected.CreateWorkload

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Synopsis

data CreateWorkload = CreateWorkload' {
- accountIds :: Maybe [Text]
- applications :: Maybe [Text]
- architecturalDesign :: Maybe Text
- awsRegions :: Maybe [Text]
- discoveryConfig :: Maybe WorkloadDiscoveryConfig
- industry :: Maybe Text
- industryType :: Maybe Text
- nonAwsRegions :: Maybe [Text]
- notes :: Maybe Text
- pillarPriorities :: Maybe [Text]
- reviewOwner :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- workloadName :: Text
- description :: Text
- environment :: WorkloadEnvironment
- lenses :: [Text]
- clientRequestToken :: Text
}
newCreateWorkload :: Text -> Text -> WorkloadEnvironment -> Text -> CreateWorkload
createWorkload_accountIds :: Lens' CreateWorkload (Maybe [Text])
createWorkload_applications :: Lens' CreateWorkload (Maybe [Text])
createWorkload_architecturalDesign :: Lens' CreateWorkload (Maybe Text)
createWorkload_awsRegions :: Lens' CreateWorkload (Maybe [Text])
createWorkload_discoveryConfig :: Lens' CreateWorkload (Maybe WorkloadDiscoveryConfig)
createWorkload_industry :: Lens' CreateWorkload (Maybe Text)
createWorkload_industryType :: Lens' CreateWorkload (Maybe Text)
createWorkload_nonAwsRegions :: Lens' CreateWorkload (Maybe [Text])
createWorkload_notes :: Lens' CreateWorkload (Maybe Text)
createWorkload_pillarPriorities :: Lens' CreateWorkload (Maybe [Text])
createWorkload_reviewOwner :: Lens' CreateWorkload (Maybe Text)
createWorkload_tags :: Lens' CreateWorkload (Maybe (HashMap Text Text))
createWorkload_workloadName :: Lens' CreateWorkload Text
createWorkload_description :: Lens' CreateWorkload Text
createWorkload_environment :: Lens' CreateWorkload WorkloadEnvironment
createWorkload_lenses :: Lens' CreateWorkload [Text]
createWorkload_clientRequestToken :: Lens' CreateWorkload Text
data CreateWorkloadResponse = CreateWorkloadResponse' {
- workloadArn :: Maybe Text
- workloadId :: Maybe Text
- httpStatus :: Int
}
newCreateWorkloadResponse :: Int -> CreateWorkloadResponse
createWorkloadResponse_workloadArn :: Lens' CreateWorkloadResponse (Maybe Text)
createWorkloadResponse_workloadId :: Lens' CreateWorkloadResponse (Maybe Text)
createWorkloadResponse_httpStatus :: Lens' CreateWorkloadResponse Int

Creating a Request

data CreateWorkload Source #

Input for workload creation.

See: newCreateWorkload smart constructor.

Constructors

CreateWorkload'

Fields

accountIds :: Maybe [Text]
applications :: Maybe [Text]
List of AppRegistry application ARNs associated to the workload.
architecturalDesign :: Maybe Text
awsRegions :: Maybe [Text]
discoveryConfig :: Maybe WorkloadDiscoveryConfig
Well-Architected discovery configuration settings associated to the workload.
industry :: Maybe Text
industryType :: Maybe Text
nonAwsRegions :: Maybe [Text]
notes :: Maybe Text
pillarPriorities :: Maybe [Text]
reviewOwner :: Maybe Text
tags :: Maybe (HashMap Text Text)
The tags to be associated with the workload.
workloadName :: Text
description :: Text
environment :: WorkloadEnvironment
lenses :: [Text]
clientRequestToken :: Text

Instances

Instances details

ToJSON CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods toJSON :: CreateWorkload -> Value # toEncoding :: CreateWorkload -> Encoding # toJSONList :: [CreateWorkload] -> Value # toEncodingList :: [CreateWorkload] -> Encoding #
ToHeaders CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods toHeaders :: CreateWorkload -> [Header] #
ToPath CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods toPath :: CreateWorkload -> ByteString #
ToQuery CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods toQuery :: CreateWorkload -> QueryString #
AWSRequest CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Associated Types type AWSResponse CreateWorkload # Methods request :: (Service -> Service) -> CreateWorkload -> Request CreateWorkload # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkload))) #
Generic CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Associated Types type Rep CreateWorkload :: Type -> Type # Methods from :: CreateWorkload -> Rep CreateWorkload x # to :: Rep CreateWorkload x -> CreateWorkload #
Read CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods readsPrec :: Int -> ReadS CreateWorkload # readList :: ReadS [CreateWorkload] # readPrec :: ReadPrec CreateWorkload # readListPrec :: ReadPrec [CreateWorkload] #
Show CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods showsPrec :: Int -> CreateWorkload -> ShowS # show :: CreateWorkload -> String # showList :: [CreateWorkload] -> ShowS #
NFData CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods rnf :: CreateWorkload -> () #
Eq CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods (==) :: CreateWorkload -> CreateWorkload -> Bool # (/=) :: CreateWorkload -> CreateWorkload -> Bool #
Hashable CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods hashWithSalt :: Int -> CreateWorkload -> Int # hash :: CreateWorkload -> Int #
type AWSResponse CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload type AWSResponse CreateWorkload = CreateWorkloadResponse
type Rep CreateWorkload Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload type Rep CreateWorkload = D1 ('MetaData "CreateWorkload" "Amazonka.WellArchitected.CreateWorkload" "amazonka-wellarchitected-2.0-B9ahtNDcb8r448GjCnHecq" 'False) (C1 ('MetaCons "CreateWorkload'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "applications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "architecturalDesign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "discoveryConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkloadDiscoveryConfig)) :: S1 ('MetaSel ('Just "industry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "industryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nonAwsRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "notes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pillarPriorities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "reviewOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "workloadName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkloadEnvironment) :: (S1 ('MetaSel ('Just "lenses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateWorkload Source #

Arguments

:: Text	`CreateWorkload`
-> Text	`CreateWorkload`
-> WorkloadEnvironment	`CreateWorkload`
-> Text	`$sel:clientRequestToken:CreateWorkload'`
-> CreateWorkload

Create a value of CreateWorkload 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:

CreateWorkload, createWorkload_accountIds - Undocumented member.

CreateWorkload, createWorkload_applications - List of AppRegistry application ARNs associated to the workload.

CreateWorkload, createWorkload_architecturalDesign - Undocumented member.

CreateWorkload, createWorkload_awsRegions - Undocumented member.

CreateWorkload, createWorkload_discoveryConfig - Well-Architected discovery configuration settings associated to the workload.

CreateWorkload, createWorkload_industry - Undocumented member.

CreateWorkload, createWorkload_industryType - Undocumented member.

CreateWorkload, createWorkload_nonAwsRegions - Undocumented member.

CreateWorkload, createWorkload_notes - Undocumented member.

CreateWorkload, createWorkload_pillarPriorities - Undocumented member.

CreateWorkload, createWorkload_reviewOwner - Undocumented member.

CreateWorkload, createWorkload_tags - The tags to be associated with the workload.

CreateWorkload, createWorkload_workloadName - Undocumented member.

CreateWorkload, createWorkload_description - Undocumented member.

CreateWorkload, createWorkload_environment - Undocumented member.

CreateWorkload, createWorkload_lenses - Undocumented member.

$sel:clientRequestToken:CreateWorkload', createWorkload_clientRequestToken - Undocumented member.

Request Lenses

createWorkload_accountIds :: Lens' CreateWorkload (Maybe [Text]) Source #

Undocumented member.

createWorkload_applications :: Lens' CreateWorkload (Maybe [Text]) Source #

List of AppRegistry application ARNs associated to the workload.

createWorkload_architecturalDesign :: Lens' CreateWorkload (Maybe Text) Source #

Undocumented member.

createWorkload_awsRegions :: Lens' CreateWorkload (Maybe [Text]) Source #

Undocumented member.

createWorkload_discoveryConfig :: Lens' CreateWorkload (Maybe WorkloadDiscoveryConfig) Source #

Well-Architected discovery configuration settings associated to the workload.

createWorkload_industry :: Lens' CreateWorkload (Maybe Text) Source #

Undocumented member.

createWorkload_industryType :: Lens' CreateWorkload (Maybe Text) Source #

Undocumented member.

createWorkload_nonAwsRegions :: Lens' CreateWorkload (Maybe [Text]) Source #

Undocumented member.

createWorkload_notes :: Lens' CreateWorkload (Maybe Text) Source #

Undocumented member.

createWorkload_pillarPriorities :: Lens' CreateWorkload (Maybe [Text]) Source #

Undocumented member.

createWorkload_reviewOwner :: Lens' CreateWorkload (Maybe Text) Source #

Undocumented member.

createWorkload_tags :: Lens' CreateWorkload (Maybe (HashMap Text Text)) Source #

The tags to be associated with the workload.

createWorkload_workloadName :: Lens' CreateWorkload Text Source #

Undocumented member.

createWorkload_description :: Lens' CreateWorkload Text Source #

Undocumented member.

createWorkload_environment :: Lens' CreateWorkload WorkloadEnvironment Source #

Undocumented member.

createWorkload_lenses :: Lens' CreateWorkload [Text] Source #

Undocumented member.

createWorkload_clientRequestToken :: Lens' CreateWorkload Text Source #

Undocumented member.

Destructuring the Response

data CreateWorkloadResponse Source #

Output of a create workload call.

See: newCreateWorkloadResponse smart constructor.

Constructors

CreateWorkloadResponse'
Fields workloadArn :: Maybe Text workloadId :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Associated Types type Rep CreateWorkloadResponse :: Type -> Type # Methods from :: CreateWorkloadResponse -> Rep CreateWorkloadResponse x # to :: Rep CreateWorkloadResponse x -> CreateWorkloadResponse #
Read CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods readsPrec :: Int -> ReadS CreateWorkloadResponse # readList :: ReadS [CreateWorkloadResponse] # readPrec :: ReadPrec CreateWorkloadResponse # readListPrec :: ReadPrec [CreateWorkloadResponse] #
Show CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods showsPrec :: Int -> CreateWorkloadResponse -> ShowS # show :: CreateWorkloadResponse -> String # showList :: [CreateWorkloadResponse] -> ShowS #
NFData CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods rnf :: CreateWorkloadResponse -> () #
Eq CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload Methods (==) :: CreateWorkloadResponse -> CreateWorkloadResponse -> Bool # (/=) :: CreateWorkloadResponse -> CreateWorkloadResponse -> Bool #
type Rep CreateWorkloadResponse Source #
Instance details Defined in Amazonka.WellArchitected.CreateWorkload type Rep CreateWorkloadResponse = D1 ('MetaData "CreateWorkloadResponse" "Amazonka.WellArchitected.CreateWorkload" "amazonka-wellarchitected-2.0-B9ahtNDcb8r448GjCnHecq" 'False) (C1 ('MetaCons "CreateWorkloadResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workloadArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "workloadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateWorkloadResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkloadResponse'`
-> CreateWorkloadResponse

Create a value of CreateWorkloadResponse 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:

CreateWorkloadResponse, createWorkloadResponse_workloadArn - Undocumented member.

CreateWorkloadResponse, createWorkloadResponse_workloadId - Undocumented member.

$sel:httpStatus:CreateWorkloadResponse', createWorkloadResponse_httpStatus - The response's http status code.

Response Lenses

createWorkloadResponse_workloadArn :: Lens' CreateWorkloadResponse (Maybe Text) Source #

Undocumented member.

createWorkloadResponse_workloadId :: Lens' CreateWorkloadResponse (Maybe Text) Source #

Undocumented member.

createWorkloadResponse_httpStatus :: Lens' CreateWorkloadResponse Int Source #

The response's http status code.