Inspector / Client / stop_assessment_run

stop_assessment_run#

Inspector.Client.stop_assessment_run(**kwargs)#

Stops the assessment run that is specified by the ARN of the assessment run.

See also: AWS API Documentation

Request Syntax

response = client.stop_assessment_run(
    assessmentRunArn='string',
    stopAction='START_EVALUATION'|'SKIP_EVALUATION'
)
Parameters:

  • assessmentRunArn (string) –

    [REQUIRED]

    The ARN of the assessment run that you want to stop.

  • stopAction (string) – An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

Returns:

None

Exceptions

  • Inspector.Client.exceptions.InternalException

  • Inspector.Client.exceptions.InvalidInputException

  • Inspector.Client.exceptions.AccessDeniedException

  • Inspector.Client.exceptions.NoSuchEntityException

  • Inspector.Client.exceptions.ServiceTemporarilyUnavailableException

Examples

Stops the assessment run that is specified by the ARN of the assessment run.

response = client.stop_assessment_run(
    assessmentRunArn='arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}