amazonka-inspector-2.0: Amazon Inspector SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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
ToJSON StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

ToHeaders StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

ToPath StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

ToQuery StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

AWSRequest StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type AWSResponse StartAssessmentRun #

Generic StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRun :: Type -> Type #

Read StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Show StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

NFData StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Methods

rnf :: StartAssessmentRun -> () #

Eq StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Hashable StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type AWSResponse StartAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRun Source # 
Instance details

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 Source #

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) 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
Generic StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Associated Types

type Rep StartAssessmentRunResponse :: Type -> Type #

Read StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Show StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

NFData StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

Eq StartAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StartAssessmentRun

type Rep StartAssessmentRunResponse Source # 
Instance details

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 Source #

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_assessmentRunArn :: Lens' StartAssessmentRunResponse Text Source #

The ARN of the assessment run that has been started.