libZSservicesZSamazonka-inspectorZSamazonka-inspector
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Inspector.StartAssessmentRun

Description

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Synopsis

Creating a Request

data StartAssessmentRun Source #

See: newStartAssessmentRun smart constructor.

Constructors

StartAssessmentRun' 

Fields

  • assessmentRunName :: Maybe Text

    You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

  • assessmentTemplateArn :: Text

    The ARN of the assessment template of the assessment run that you want to start.

Instances

Instances details
Eq StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

(==) :: StartAssessmentRun -> StartAssessmentRun -> Bool #

(/=) :: StartAssessmentRun -> StartAssessmentRun -> Bool #

Read StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRun #

readList :: ReadS [StartAssessmentRun] #

readPrec :: ReadPrec StartAssessmentRun #

readListPrec :: ReadPrec [StartAssessmentRun] #

Show StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRun -> ShowS #

show :: StartAssessmentRun -> String #

showList :: [StartAssessmentRun] -> ShowS #

Generic StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRun :: Type -> Type #

Methods

from :: StartAssessmentRun -> Rep StartAssessmentRun x #

to :: Rep StartAssessmentRun x -> StartAssessmentRun #

NFData StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRun -> () #

Hashable StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

hashWithSalt :: Int -> StartAssessmentRun -> Int #

hash :: StartAssessmentRun -> Int #

ToJSON StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toJSON :: StartAssessmentRun -> Value #

toEncoding :: StartAssessmentRun -> Encoding #

toJSONList :: [StartAssessmentRun] -> Value #

toEncodingList :: [StartAssessmentRun] -> Encoding #

AWSRequest StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type AWSResponse StartAssessmentRun #

Methods

request :: StartAssessmentRun -> Request StartAssessmentRun #

response :: MonadResource m => Logger -> Service -> Proxy StartAssessmentRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartAssessmentRun))) #

ToHeaders StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toHeaders :: StartAssessmentRun -> [Header] #

ToPath StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toPath :: StartAssessmentRun -> ByteString #

ToQuery StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toQuery :: StartAssessmentRun -> QueryString #

type Rep StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRun = D1 ('MetaData "StartAssessmentRun" "Amazonka.Inspector.StartAssessmentRun" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "StartAssessmentRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assessmentRunName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assessmentTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type AWSResponse StartAssessmentRun = StartAssessmentRunResponse

newStartAssessmentRun Source #

Arguments

:: Text

$sel:assessmentTemplateArn:StartAssessmentRun'

-> StartAssessmentRun 

Create a value of StartAssessmentRun 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:assessmentRunName:StartAssessmentRun', startAssessmentRun_assessmentRunName - You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

$sel:assessmentTemplateArn:StartAssessmentRun', startAssessmentRun_assessmentTemplateArn - The ARN of the assessment template of the assessment run that you want to start.

Request Lenses

startAssessmentRun_assessmentRunName :: Lens' StartAssessmentRun (Maybe Text) Source #

You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

startAssessmentRun_assessmentTemplateArn :: Lens' StartAssessmentRun Text Source #

The ARN of the assessment template of the assessment run that you want to start.

Destructuring the Response

data StartAssessmentRunResponse Source #

See: newStartAssessmentRunResponse smart constructor.

Constructors

StartAssessmentRunResponse' 

Fields

Instances

Instances details
Eq StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

(==) :: StartAssessmentRunResponse -> StartAssessmentRunResponse -> Bool #

(/=) :: StartAssessmentRunResponse -> StartAssessmentRunResponse -> Bool #

Read StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRunResponse #

readList :: ReadS [StartAssessmentRunResponse] #

readPrec :: ReadPrec StartAssessmentRunResponse #

readListPrec :: ReadPrec [StartAssessmentRunResponse] #

Show StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRunResponse -> ShowS #

show :: StartAssessmentRunResponse -> String #

showList :: [StartAssessmentRunResponse] -> ShowS #

Generic StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRunResponse :: Type -> Type #

Methods

from :: StartAssessmentRunResponse -> Rep StartAssessmentRunResponse x #

to :: Rep StartAssessmentRunResponse x -> StartAssessmentRunResponse #

NFData StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRunResponse -> () #

type Rep StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRunResponse = D1 ('MetaData "StartAssessmentRunResponse" "Amazonka.Inspector.StartAssessmentRun" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "StartAssessmentRunResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "assessmentRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartAssessmentRunResponse Source #

Arguments

:: Int

$sel:httpStatus:StartAssessmentRunResponse'

-> Text

$sel:assessmentRunArn:StartAssessmentRunResponse'

-> StartAssessmentRunResponse 

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

$sel:assessmentRunArn:StartAssessmentRunResponse', startAssessmentRunResponse_assessmentRunArn - The ARN of the assessment run that has been started.

Response Lenses

startAssessmentRunResponse_httpStatus :: Lens' StartAssessmentRunResponse Int Source #

The response's http status code.

startAssessmentRunResponse_assessmentRunArn :: Lens' StartAssessmentRunResponse Text Source #

The ARN of the assessment run that has been started.