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.StartAppAssessment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new application assessment for an application.

Synopsis

data StartAppAssessment = StartAppAssessment' {
- clientToken :: Maybe Text
- tags :: Maybe (Sensitive (HashMap Text Text))
- appArn :: Text
- appVersion :: Text
- assessmentName :: Text
}
newStartAppAssessment :: Text -> Text -> Text -> StartAppAssessment
startAppAssessment_clientToken :: Lens' StartAppAssessment (Maybe Text)
startAppAssessment_tags :: Lens' StartAppAssessment (Maybe (HashMap Text Text))
startAppAssessment_appArn :: Lens' StartAppAssessment Text
startAppAssessment_appVersion :: Lens' StartAppAssessment Text
startAppAssessment_assessmentName :: Lens' StartAppAssessment Text
data StartAppAssessmentResponse = StartAppAssessmentResponse' {
- httpStatus :: Int
- assessment :: AppAssessment
}
newStartAppAssessmentResponse :: Int -> AppAssessment -> StartAppAssessmentResponse
startAppAssessmentResponse_httpStatus :: Lens' StartAppAssessmentResponse Int
startAppAssessmentResponse_assessment :: Lens' StartAppAssessmentResponse AppAssessment

Creating a Request

data StartAppAssessment Source #

See: newStartAppAssessment smart constructor.

Constructors

StartAppAssessment'

Fields

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.
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.
appArn :: Text
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
appVersion :: Text
The version of the application.
assessmentName :: Text
The name for the assessment.

Instances

Instances details

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

newStartAppAssessment Source #

Arguments

:: Text	`StartAppAssessment`
-> Text	`StartAppAssessment`
-> Text	`StartAppAssessment`
-> StartAppAssessment

Create a value of StartAppAssessment 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:StartAppAssessment', startAppAssessment_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.

StartAppAssessment, startAppAssessment_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.

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

StartAppAssessment, startAppAssessment_appVersion - The version of the application.

StartAppAssessment, startAppAssessment_assessmentName - The name for the assessment.

Request Lenses

startAppAssessment_clientToken :: Lens' StartAppAssessment (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.

startAppAssessment_tags :: Lens' StartAppAssessment (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.

startAppAssessment_appArn :: Lens' StartAppAssessment Text Source #

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

startAppAssessment_appVersion :: Lens' StartAppAssessment Text Source #

The version of the application.

startAppAssessment_assessmentName :: Lens' StartAppAssessment Text Source #

The name for the assessment.

Destructuring the Response

data StartAppAssessmentResponse Source #

See: newStartAppAssessmentResponse smart constructor.

Constructors

StartAppAssessmentResponse'
Fields httpStatus :: Int The response's http status code. assessment :: AppAssessment The assessment created.

Instances

Instances details

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

newStartAppAssessmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartAppAssessmentResponse'`
-> AppAssessment	`$sel:assessment:StartAppAssessmentResponse'`
-> StartAppAssessmentResponse

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

$sel:assessment:StartAppAssessmentResponse', startAppAssessmentResponse_assessment - The assessment created.

Response Lenses

startAppAssessmentResponse_httpStatus :: Lens' StartAppAssessmentResponse Int Source #

The response's http status code.

startAppAssessmentResponse_assessment :: Lens' StartAppAssessmentResponse AppAssessment Source #

The assessment created.