Inspector2 / Client / get_cis_scan_report

get_cis_scan_report#

Inspector2.Client.get_cis_scan_report(**kwargs)#

Retrieves a CIS scan report.

See also: AWS API Documentation

Request Syntax

response = client.get_cis_scan_report(
    reportFormat='PDF'|'CSV',
    scanArn='string',
    targetAccounts=[
        'string',
    ]
)
Parameters:
  • reportFormat (string) – The format of the report. Valid values are PDF and CSV. If no value is specified, the report format defaults to PDF.

  • scanArn (string) –

    [REQUIRED]

    The scan ARN.

  • targetAccounts (list) –

    The target accounts.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
    'url': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The status.

    • url (string) –

      The URL where a PDF or CSV of the CIS scan report can be downloaded.

Exceptions

  • Inspector2.Client.exceptions.ValidationException

  • Inspector2.Client.exceptions.AccessDeniedException

  • Inspector2.Client.exceptions.ThrottlingException

  • Inspector2.Client.exceptions.ResourceNotFoundException

  • Inspector2.Client.exceptions.InternalServerException