Inspector2 / Client / create_cis_scan_configuration

create_cis_scan_configuration#

Inspector2.Client.create_cis_scan_configuration(**kwargs)#

Creates a CIS scan configuration.

Request Syntax

response = client.create_cis_scan_configuration(
    scanName='string',
    schedule={
        'daily': {
            'startTime': {
                'timeOfDay': 'string',
                'timezone': 'string'
            }
        },
        'monthly': {
            'day': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
            'startTime': {
                'timeOfDay': 'string',
                'timezone': 'string'
            }
        },
        'oneTime': {}
        ,
        'weekly': {
            'days': [
                'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
            ],
            'startTime': {
                'timeOfDay': 'string',
                'timezone': 'string'
            }
        }
    },
    securityLevel='LEVEL_1'|'LEVEL_2',
    tags={
        'string': 'string'
    },
    targets={
        'accountIds': [
            'string',
        ],
        'targetResourceTags': {
            'string': [
                'string',
            ]
        }
    }
)

Parameters:

scanName (string) –
[REQUIRED]

The scan name for the CIS scan configuration.
schedule (dict) –
[REQUIRED]

The schedule for the CIS scan configuration.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: daily, monthly, oneTime, weekly.
- daily (dict) –
  
  The schedule’s daily.
  - startTime (dict) – [REQUIRED]
    
    The schedule start time.
    - timeOfDay (string) – [REQUIRED]
      
      The time of day in 24-hour format (00:00).
    - timezone (string) – [REQUIRED]
      
      The timezone.
- monthly (dict) –
  
  The schedule’s monthly.
  - day (string) – [REQUIRED]
    
    The monthly schedule’s day.
  - startTime (dict) – [REQUIRED]
    
    The monthly schedule’s start time.
    - timeOfDay (string) – [REQUIRED]
      
      The time of day in 24-hour format (00:00).
    - timezone (string) – [REQUIRED]
      
      The timezone.
- oneTime (dict) –
  
  The schedule’s one time.
- weekly (dict) –
  
  The schedule’s weekly.
  - days (list) – [REQUIRED]
    
    The weekly schedule’s days.
    - (string) –
  - startTime (dict) – [REQUIRED]
    
    The weekly schedule’s start time.
    - timeOfDay (string) – [REQUIRED]
      
      The time of day in 24-hour format (00:00).
    - timezone (string) – [REQUIRED]
      
      The timezone.
securityLevel (string) –
[REQUIRED]

The security level for the CIS scan configuration. Security level refers to the Benchmark levels that CIS assigns to a profile.
tags (dict) –
The tags for the CIS scan configuration.
- (string) –
  - (string) –
targets (dict) –
[REQUIRED]

The targets for the CIS scan configuration.
- accountIds (list) – [REQUIRED]
  
  The CIS target account ids.
  - (string) –
- targetResourceTags (dict) – [REQUIRED]
  
  The CIS target resource tags.
  - (string) –
    - (list) –
      - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'scanConfigurationArn': 'string'
}

Response Structure

(dict) –
- scanConfigurationArn (string) –
  
  The scan configuration ARN for the CIS scan configuration.

Exceptions

Inspector2.Client.exceptions.ValidationException
Inspector2.Client.exceptions.AccessDeniedException
Inspector2.Client.exceptions.ThrottlingException
Inspector2.Client.exceptions.InternalServerException