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.ResilienceHub.CreateRecommendationTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new recommendation template.

Synopsis

Creating a Request

data CreateRecommendationTemplate Source #

See: newCreateRecommendationTemplate smart constructor.

Constructors

CreateRecommendationTemplate'

Fields

bucketName :: Maybe Text
The name of the Amazon S3 bucket that will contain the recommendation template.
clientToken :: Maybe Text
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
format :: Maybe TemplateFormat
The format for the recommendation template.
CfnJson
The template is CloudFormation JSON.
CfnYaml
The template is CloudFormation YAML.
recommendationIds :: Maybe (NonEmpty Text)
Identifiers for the recommendations used to create a recommendation template.
recommendationTypes :: Maybe (NonEmpty RenderRecommendationType)
An array of strings that specify the recommendation template type or types.
Alarm
The template is an AlarmRecommendation template.
Sop
The template is a SopRecommendation template.
Test
The template is a TestRecommendation template.
tags :: Maybe (Sensitive (HashMap Text Text))
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
assessmentArn :: Text
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
name :: Text
The name for the recommendation template.

Instances

Instances details

ToJSON CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods toJSON :: CreateRecommendationTemplate -> Value # toEncoding :: CreateRecommendationTemplate -> Encoding # toJSONList :: [CreateRecommendationTemplate] -> Value # toEncodingList :: [CreateRecommendationTemplate] -> Encoding #
ToHeaders CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods toHeaders :: CreateRecommendationTemplate -> [Header] #
ToPath CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods toPath :: CreateRecommendationTemplate -> ByteString #
ToQuery CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods toQuery :: CreateRecommendationTemplate -> QueryString #
AWSRequest CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Associated Types type AWSResponse CreateRecommendationTemplate # Methods request :: (Service -> Service) -> CreateRecommendationTemplate -> Request CreateRecommendationTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRecommendationTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRecommendationTemplate))) #
Generic CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Associated Types type Rep CreateRecommendationTemplate :: Type -> Type # Methods from :: CreateRecommendationTemplate -> Rep CreateRecommendationTemplate x # to :: Rep CreateRecommendationTemplate x -> CreateRecommendationTemplate #
Show CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods showsPrec :: Int -> CreateRecommendationTemplate -> ShowS # show :: CreateRecommendationTemplate -> String # showList :: [CreateRecommendationTemplate] -> ShowS #
NFData CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods rnf :: CreateRecommendationTemplate -> () #
Eq CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods (==) :: CreateRecommendationTemplate -> CreateRecommendationTemplate -> Bool # (/=) :: CreateRecommendationTemplate -> CreateRecommendationTemplate -> Bool #
Hashable CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods hashWithSalt :: Int -> CreateRecommendationTemplate -> Int # hash :: CreateRecommendationTemplate -> Int #
type AWSResponse CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate type AWSResponse CreateRecommendationTemplate = CreateRecommendationTemplateResponse
type Rep CreateRecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate type Rep CreateRecommendationTemplate = D1 ('MetaData "CreateRecommendationTemplate" "Amazonka.ResilienceHub.CreateRecommendationTemplate" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "CreateRecommendationTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateFormat)) :: S1 ('MetaSel ('Just "recommendationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :: ((S1 ('MetaSel ('Just "recommendationTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RenderRecommendationType))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "assessmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateRecommendationTemplate Source #

Arguments

:: Text	`CreateRecommendationTemplate`
-> Text	`CreateRecommendationTemplate`
-> CreateRecommendationTemplate

Create a value of CreateRecommendationTemplate 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:bucketName:CreateRecommendationTemplate', createRecommendationTemplate_bucketName - The name of the Amazon S3 bucket that will contain the recommendation template.

$sel:clientToken:CreateRecommendationTemplate', createRecommendationTemplate_clientToken - Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

CreateRecommendationTemplate, createRecommendationTemplate_format - The format for the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

CreateRecommendationTemplate, createRecommendationTemplate_recommendationIds - Identifiers for the recommendations used to create a recommendation template.

CreateRecommendationTemplate, createRecommendationTemplate_recommendationTypes - An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

CreateRecommendationTemplate, createRecommendationTemplate_tags - The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

CreateRecommendationTemplate, createRecommendationTemplate_assessmentArn - The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

CreateRecommendationTemplate, createRecommendationTemplate_name - The name for the recommendation template.

Request Lenses

createRecommendationTemplate_bucketName :: Lens' CreateRecommendationTemplate (Maybe Text) Source #

The name of the Amazon S3 bucket that will contain the recommendation template.

createRecommendationTemplate_clientToken :: Lens' CreateRecommendationTemplate (Maybe Text) Source #

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

createRecommendationTemplate_format :: Lens' CreateRecommendationTemplate (Maybe TemplateFormat) Source #

The format for the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

createRecommendationTemplate_recommendationIds :: Lens' CreateRecommendationTemplate (Maybe (NonEmpty Text)) Source #

Identifiers for the recommendations used to create a recommendation template.

createRecommendationTemplate_recommendationTypes :: Lens' CreateRecommendationTemplate (Maybe (NonEmpty RenderRecommendationType)) Source #

An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

createRecommendationTemplate_tags :: Lens' CreateRecommendationTemplate (Maybe (HashMap Text Text)) Source #

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

createRecommendationTemplate_assessmentArn :: Lens' CreateRecommendationTemplate Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

createRecommendationTemplate_name :: Lens' CreateRecommendationTemplate Text Source #

The name for the recommendation template.

Destructuring the Response

data CreateRecommendationTemplateResponse Source #

See: newCreateRecommendationTemplateResponse smart constructor.

Constructors

CreateRecommendationTemplateResponse'
Fields recommendationTemplate :: Maybe RecommendationTemplate The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateRecommendationTemplateResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Associated Types type Rep CreateRecommendationTemplateResponse :: Type -> Type # Methods from :: CreateRecommendationTemplateResponse -> Rep CreateRecommendationTemplateResponse x # to :: Rep CreateRecommendationTemplateResponse x -> CreateRecommendationTemplateResponse #
Show CreateRecommendationTemplateResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods showsPrec :: Int -> CreateRecommendationTemplateResponse -> ShowS # show :: CreateRecommendationTemplateResponse -> String # showList :: [CreateRecommendationTemplateResponse] -> ShowS #
NFData CreateRecommendationTemplateResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods rnf :: CreateRecommendationTemplateResponse -> () #
Eq CreateRecommendationTemplateResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate Methods (==) :: CreateRecommendationTemplateResponse -> CreateRecommendationTemplateResponse -> Bool # (/=) :: CreateRecommendationTemplateResponse -> CreateRecommendationTemplateResponse -> Bool #
type Rep CreateRecommendationTemplateResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateRecommendationTemplate type Rep CreateRecommendationTemplateResponse = D1 ('MetaData "CreateRecommendationTemplateResponse" "Amazonka.ResilienceHub.CreateRecommendationTemplate" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "CreateRecommendationTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recommendationTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationTemplate)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateRecommendationTemplateResponse Source #

Arguments

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

Create a value of CreateRecommendationTemplateResponse 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:recommendationTemplate:CreateRecommendationTemplateResponse', createRecommendationTemplateResponse_recommendationTemplate - The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.

$sel:httpStatus:CreateRecommendationTemplateResponse', createRecommendationTemplateResponse_httpStatus - The response's http status code.

Response Lenses

createRecommendationTemplateResponse_recommendationTemplate :: Lens' CreateRecommendationTemplateResponse (Maybe RecommendationTemplate) Source #

The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.

createRecommendationTemplateResponse_httpStatus :: Lens' CreateRecommendationTemplateResponse Int Source #

The response's http status code.