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

data StartAssessmentRun

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

ToJSON StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toJSON :: StartAssessmentRun -> Value

toEncoding :: StartAssessmentRun -> Encoding

toJSONList :: [StartAssessmentRun] -> Value

toEncodingList :: [StartAssessmentRun] -> Encoding

ToHeaders StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toHeaders :: StartAssessmentRun -> [Header]

ToPath StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toPath :: StartAssessmentRun -> ByteString

ToQuery StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

toQuery :: StartAssessmentRun -> QueryString

AWSRequest StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type AWSResponse StartAssessmentRun

Methods

request :: (Service -> Service) -> StartAssessmentRun -> Request StartAssessmentRun

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

Generic StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRun :: Type -> Type

Methods

from :: StartAssessmentRun -> Rep StartAssessmentRun x

to :: Rep StartAssessmentRun x -> StartAssessmentRun

Read StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRun

readList :: ReadS [StartAssessmentRun]

readPrec :: ReadPrec StartAssessmentRun

readListPrec :: ReadPrec [StartAssessmentRun]

Show StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRun -> ShowS

show :: StartAssessmentRun -> String

showList :: [StartAssessmentRun] -> ShowS

NFData StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRun -> ()

Eq StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

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

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

Hashable StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

hashWithSalt :: Int -> StartAssessmentRun -> Int

hash :: StartAssessmentRun -> Int

type AWSResponse StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

type AWSResponse StartAssessmentRun = StartAssessmentRunResponse

type Rep StartAssessmentRun

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRun = D1 ('MetaData "StartAssessmentRun" "Amazonka.Inspector.StartAssessmentRun" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" '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)))

newStartAssessmentRun

Arguments

:: Text

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.

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)

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

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

Destructuring the Response

data StartAssessmentRunResponse

See: newStartAssessmentRunResponse smart constructor.

Constructors

StartAssessmentRunResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• assessmentRunArn :: Text

  The ARN of the assessment run that has been started.

Instances

Generic StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRunResponse :: Type -> Type

Methods

from :: StartAssessmentRunResponse -> Rep StartAssessmentRunResponse x

to :: Rep StartAssessmentRunResponse x -> StartAssessmentRunResponse

Read StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

readsPrec :: Int -> ReadS StartAssessmentRunResponse

readList :: ReadS [StartAssessmentRunResponse]

readPrec :: ReadPrec StartAssessmentRunResponse

readListPrec :: ReadPrec [StartAssessmentRunResponse]

Show StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

showsPrec :: Int -> StartAssessmentRunResponse -> ShowS

show :: StartAssessmentRunResponse -> String

showList :: [StartAssessmentRunResponse] -> ShowS

NFData StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRunResponse -> ()

Eq StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

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

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

type Rep StartAssessmentRunResponse

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRunResponse = D1 ('MetaData "StartAssessmentRunResponse" "Amazonka.Inspector.StartAssessmentRun" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" '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

Arguments

:: Int

$sel:httpStatus:StartAssessmentRunResponse'

-> Text

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.

StartAssessmentRunResponse, startAssessmentRunResponse_assessmentRunArn - The ARN of the assessment run that has been started.

Response Lenses

startAssessmentRunResponse_httpStatus :: Lens' StartAssessmentRunResponse Int

The response's http status code.

startAssessmentRunResponse_assessmentRunArn :: Lens' StartAssessmentRunResponse Text

The ARN of the assessment run that has been started.