Inspector / Client / start_assessment_run

start_assessment_run#

Inspector.Client.start_assessment_run(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.start_assessment_run(
    assessmentTemplateArn='string',
    assessmentRunName='string'
)
Parameters:

  • assessmentTemplateArn (string) –

    [REQUIRED]

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

  • assessmentRunName (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentRunArn': 'string'
}

Response Structure

  • (dict) –

    • assessmentRunArn (string) –

      The ARN of the assessment run that has been started.

Exceptions

  • Inspector.Client.exceptions.InternalException

  • Inspector.Client.exceptions.InvalidInputException

  • Inspector.Client.exceptions.LimitExceededException

  • Inspector.Client.exceptions.AccessDeniedException

  • Inspector.Client.exceptions.NoSuchEntityException

  • Inspector.Client.exceptions.InvalidCrossAccountRoleException

  • Inspector.Client.exceptions.AgentsAlreadyRunningAssessmentException

  • Inspector.Client.exceptions.ServiceTemporarilyUnavailableException

Examples

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.

response = client.start_assessment_run(
    assessmentRunName='examplerun',
    assessmentTemplateArn='arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T',
)

print(response)

Expected Output:

{
    'assessmentRunArn': 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY',
    'ResponseMetadata': {
        '...': '...',
    },
}