Network.AWS.Inspector.StartAssessmentRun

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.

Creating a Request

startAssessmentRun

Arguments

:: Text

sarAssessmentTemplateARN

-> StartAssessmentRun

Creates a value of StartAssessmentRun with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sarAssessmentRunName - 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.
• sarAssessmentTemplateARN - The ARN of the assessment template of the assessment run that you want to start.

data StartAssessmentRun

See: startAssessmentRun smart constructor.

Instances

Eq StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

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

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

Data StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartAssessmentRun -> c StartAssessmentRun

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartAssessmentRun

toConstr :: StartAssessmentRun -> Constr

dataTypeOf :: StartAssessmentRun -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartAssessmentRun)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartAssessmentRun)

gmapT :: (forall b. Data b => b -> b) -> StartAssessmentRun -> StartAssessmentRun

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartAssessmentRun -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartAssessmentRun -> r

gmapQ :: (forall d. Data d => d -> u) -> StartAssessmentRun -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartAssessmentRun -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartAssessmentRun -> m StartAssessmentRun

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartAssessmentRun -> m StartAssessmentRun

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartAssessmentRun -> m StartAssessmentRun

Read StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRun

readList :: ReadS [StartAssessmentRun]

readPrec :: ReadPrec StartAssessmentRun

readListPrec :: ReadPrec [StartAssessmentRun]

Show StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRun -> ShowS

show :: StartAssessmentRun -> String

showList :: [StartAssessmentRun] -> ShowS

Generic StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRun :: Type -> Type

Methods

from :: StartAssessmentRun -> Rep StartAssessmentRun x

to :: Rep StartAssessmentRun x -> StartAssessmentRun

Hashable StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

hashWithSalt :: Int -> StartAssessmentRun -> Int

hash :: StartAssessmentRun -> Int

ToJSON StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

toJSON :: StartAssessmentRun -> Value

toEncoding :: StartAssessmentRun -> Encoding

toJSONList :: [StartAssessmentRun] -> Value

toEncodingList :: [StartAssessmentRun] -> Encoding

AWSRequest StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Associated Types

type Rs StartAssessmentRun :: Type

Methods

request :: StartAssessmentRun -> Request StartAssessmentRun

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StartAssessmentRun -> ClientResponse -> m (Response StartAssessmentRun)

ToHeaders StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

toHeaders :: StartAssessmentRun -> [Header]

ToPath StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

toPath :: StartAssessmentRun -> ByteString

ToQuery StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

toQuery :: StartAssessmentRun -> QueryString

NFData StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRun -> ()

type Rep StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

type Rep StartAssessmentRun = D1 (MetaData "StartAssessmentRun" "Network.AWS.Inspector.StartAssessmentRun" "amazonka-inspector-1.6.1-1xH2ya8w5ZlLuhJEcN8K8C" False) (C1 (MetaCons "StartAssessmentRun'" PrefixI True) (S1 (MetaSel (Just "_sarAssessmentRunName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sarAssessmentTemplateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs StartAssessmentRun

Defined in Network.AWS.Inspector.StartAssessmentRun

type Rs StartAssessmentRun = StartAssessmentRunResponse

Request Lenses

sarAssessmentRunName :: Lens' StartAssessmentRun (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.

sarAssessmentTemplateARN :: Lens' StartAssessmentRun Text

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

Destructuring the Response

startAssessmentRunResponse

Arguments

:: Int

sarrsResponseStatus

-> Text

sarrsAssessmentRunARN

-> StartAssessmentRunResponse

Creates a value of StartAssessmentRunResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sarrsResponseStatus - -- | The response status code.
• sarrsAssessmentRunARN - The ARN of the assessment run that has been started.

data StartAssessmentRunResponse

See: startAssessmentRunResponse smart constructor.

Instances

Eq StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

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

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

Data StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartAssessmentRunResponse -> c StartAssessmentRunResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartAssessmentRunResponse

toConstr :: StartAssessmentRunResponse -> Constr

dataTypeOf :: StartAssessmentRunResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartAssessmentRunResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartAssessmentRunResponse)

gmapT :: (forall b. Data b => b -> b) -> StartAssessmentRunResponse -> StartAssessmentRunResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartAssessmentRunResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartAssessmentRunResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartAssessmentRunResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartAssessmentRunResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartAssessmentRunResponse -> m StartAssessmentRunResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartAssessmentRunResponse -> m StartAssessmentRunResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartAssessmentRunResponse -> m StartAssessmentRunResponse

Read StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRunResponse

readList :: ReadS [StartAssessmentRunResponse]

readPrec :: ReadPrec StartAssessmentRunResponse

readListPrec :: ReadPrec [StartAssessmentRunResponse]

Show StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRunResponse -> ShowS

show :: StartAssessmentRunResponse -> String

showList :: [StartAssessmentRunResponse] -> ShowS

Generic StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRunResponse :: Type -> Type

Methods

from :: StartAssessmentRunResponse -> Rep StartAssessmentRunResponse x

to :: Rep StartAssessmentRunResponse x -> StartAssessmentRunResponse

NFData StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRunResponse -> ()

type Rep StartAssessmentRunResponse

Defined in Network.AWS.Inspector.StartAssessmentRun

type Rep StartAssessmentRunResponse = D1 (MetaData "StartAssessmentRunResponse" "Network.AWS.Inspector.StartAssessmentRun" "amazonka-inspector-1.6.1-1xH2ya8w5ZlLuhJEcN8K8C" False) (C1 (MetaCons "StartAssessmentRunResponse'" PrefixI True) (S1 (MetaSel (Just "_sarrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_sarrsAssessmentRunARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

Response Lenses

sarrsResponseStatus :: Lens' StartAssessmentRunResponse Int

• - | The response status code.

sarrsAssessmentRunARN :: Lens' StartAssessmentRunResponse Text

The ARN of the assessment run that has been started.