AWS API Changes

2025/06/17 - Inspector2 - 15 new19 updated api methods

Changes Add Code Repository Scanning as part of AWS InspectorV2

GetCodeSecurityScanConfiguration (new)

Link ¶

Retrieves information about a code security scan configuration.

Request Syntax

client.get_code_security_scan_configuration(
    scanConfigurationArn='string'
)

type scanConfigurationArn:

string

param scanConfigurationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the scan configuration to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'configuration': {
        'continuousIntegrationScanConfiguration': {
            'supportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ]
        },
        'periodicScanConfiguration': {
            'frequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'frequencyExpression': 'string'
        },
        'ruleSetCategories': [
            'SAST'|'IAC'|'SCA',
        ]
    },
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'level': 'ORGANIZATION'|'ACCOUNT',
    'name': 'string',
    'scanConfigurationArn': 'string',
    'scopeSettings': {
        'projectSelectionScope': 'ALL'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- configuration (dict) --
  
  The configuration settings for the code security scan.
  - continuousIntegrationScanConfiguration (dict) --
    
    Configuration settings for continuous integration scans that run automatically when code changes are made.
    - supportedEvents (list) --
      
      The repository events that trigger continuous integration scans, such as pull requests or commits.
      - (string) --
  - periodicScanConfiguration (dict) --
    
    Configuration settings for periodic scans that run on a scheduled basis.
    - frequency (string) --
      
      The frequency at which periodic scans are performed (such as weekly or monthly).
      
      If you don't provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression, the schedule must match the specified frequency.
    - frequencyExpression (string) --
      
      The schedule expression for periodic scans, in cron format.
  - ruleSetCategories (list) --
    
    The categories of security rules to be applied during the scan.
    - (string) --
- createdAt (datetime) --
  
  The timestamp when the scan configuration was created.
- lastUpdatedAt (datetime) --
  
  The timestamp when the scan configuration was last updated.
- level (string) --
  
  The security level for the scan configuration.
- name (string) --
  
  The name of the scan configuration.
- scanConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) of the scan configuration.
- scopeSettings (dict) --
  
  The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.
  - projectSelectionScope (string) --
    
    The scope of projects to be selected for scanning within the integrated repositories. Setting the value to ALL applies the scope settings to all existing and future projects imported into Amazon Inspector.
- tags (dict) --
  
  The tags associated with the scan configuration.
  - (string) --
    - (string) --

ListCodeSecurityScanConfigurations (new)

Link ¶

Lists all code security scan configurations in your account.

See also: AWS API Documentation

Request Syntax

client.list_code_security_scan_configurations(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

rtype:

dict

returns:

Response Syntax

{
    'configurations': [
        {
            'continuousIntegrationScanSupportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ],
            'frequencyExpression': 'string',
            'name': 'string',
            'ownerAccountId': 'string',
            'periodicScanFrequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'ruleSetCategories': [
                'SAST'|'IAC'|'SCA',
            ],
            'scanConfigurationArn': 'string',
            'scopeSettings': {
                'projectSelectionScope': 'ALL'
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- configurations (list) --
  
  A list of code security scan configuration summaries.
  - (dict) --
    
    A summary of information about a code security scan configuration.
    - continuousIntegrationScanSupportedEvents (list) --
      
      The repository events that trigger continuous integration scans.
      - (string) --
    - frequencyExpression (string) --
      
      The schedule expression for periodic scans, in cron format.
    - name (string) --
      
      The name of the scan configuration.
    - ownerAccountId (string) --
      
      The Amazon Web Services account ID that owns the scan configuration.
    - periodicScanFrequency (string) --
      
      The frequency at which periodic scans are performed.
    - ruleSetCategories (list) --
      
      The categories of security rules applied during the scan.
      - (string) --
    - scanConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the scan configuration.
    - scopeSettings (dict) --
      
      The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.
      - projectSelectionScope (string) --
        
        The scope of projects to be selected for scanning within the integrated repositories. Setting the value to ALL applies the scope settings to all existing and future projects imported into Amazon Inspector.
    - tags (dict) --
      
      The tags associated with the scan configuration.
      - (string) --
        
        (string) --
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

UpdateCodeSecurityScanConfiguration (new)

Link ¶

Updates an existing code security scan configuration.

See also: AWS API Documentation

Request Syntax

client.update_code_security_scan_configuration(
    configuration={
        'continuousIntegrationScanConfiguration': {
            'supportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ]
        },
        'periodicScanConfiguration': {
            'frequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'frequencyExpression': 'string'
        },
        'ruleSetCategories': [
            'SAST'|'IAC'|'SCA',
        ]
    },
    scanConfigurationArn='string'
)

type configuration:

dict

param configuration:

[REQUIRED]

The updated configuration settings for the code security scan.

continuousIntegrationScanConfiguration (dict) --

Configuration settings for continuous integration scans that run automatically when code changes are made.
- supportedEvents (list) -- [REQUIRED]
  
  The repository events that trigger continuous integration scans, such as pull requests or commits.
  - (string) --
periodicScanConfiguration (dict) --

Configuration settings for periodic scans that run on a scheduled basis.
- frequency (string) --
  
  The frequency at which periodic scans are performed (such as weekly or monthly).
  
  If you don't provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression, the schedule must match the specified frequency.
- frequencyExpression (string) --
  
  The schedule expression for periodic scans, in cron format.
ruleSetCategories (list) -- [REQUIRED]

The categories of security rules to be applied during the scan.
- (string) --

type scanConfigurationArn:

string

param scanConfigurationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the scan configuration to update.

rtype:

dict

returns:

Response Syntax

{
    'scanConfigurationArn': 'string'
}

Response Structure

(dict) --
- scanConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) of the updated scan configuration.

CreateCodeSecurityScanConfiguration (new)

Link ¶

Creates a scan configuration for code security scanning.

See also: AWS API Documentation

Request Syntax

client.create_code_security_scan_configuration(
    configuration={
        'continuousIntegrationScanConfiguration': {
            'supportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ]
        },
        'periodicScanConfiguration': {
            'frequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'frequencyExpression': 'string'
        },
        'ruleSetCategories': [
            'SAST'|'IAC'|'SCA',
        ]
    },
    level='ORGANIZATION'|'ACCOUNT',
    name='string',
    scopeSettings={
        'projectSelectionScope': 'ALL'
    },
    tags={
        'string': 'string'
    }
)

type configuration:

dict

param configuration:

[REQUIRED]

The configuration settings for the code security scan.

continuousIntegrationScanConfiguration (dict) --

Configuration settings for continuous integration scans that run automatically when code changes are made.
- supportedEvents (list) -- [REQUIRED]
  
  The repository events that trigger continuous integration scans, such as pull requests or commits.
  - (string) --
periodicScanConfiguration (dict) --

Configuration settings for periodic scans that run on a scheduled basis.
- frequency (string) --
  
  The frequency at which periodic scans are performed (such as weekly or monthly).
  
  If you don't provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression, the schedule must match the specified frequency.
- frequencyExpression (string) --
  
  The schedule expression for periodic scans, in cron format.
ruleSetCategories (list) -- [REQUIRED]

The categories of security rules to be applied during the scan.
- (string) --

type level:

string

param level:

[REQUIRED]

The security level for the scan configuration.

type name:

string

param name:

[REQUIRED]

The name of the scan configuration.

type scopeSettings:

dict

param scopeSettings:

The scope settings that define which repositories will be scanned. Include this parameter to create a default scan configuration. Otherwise Amazon Inspector creates a general scan configuration.

A default scan configuration automatically applies to all existing and future projects imported into Amazon Inspector. Use the BatchAssociateCodeSecurityScanConfiguration operation to associate a general scan configuration with projects.

projectSelectionScope (string) --

The scope of projects to be selected for scanning within the integrated repositories. Setting the value to ALL applies the scope settings to all existing and future projects imported into Amazon Inspector.

type tags:

dict

param tags:

The tags to apply to the scan configuration.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'scanConfigurationArn': 'string'
}

Response Structure

(dict) --
- scanConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) of the created scan configuration.

DeleteCodeSecurityIntegration (new)

Link ¶

Deletes a code security integration.

See also: AWS API Documentation

Request Syntax

client.delete_code_security_integration(
    integrationArn='string'
)

type integrationArn:

string

param integrationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the code security integration to delete.

rtype:

dict

returns:

Response Syntax

{
    'integrationArn': 'string'
}

Response Structure

(dict) --
- integrationArn (string) --
  
  The Amazon Resource Name (ARN) of the deleted code security integration.

ListCodeSecurityScanConfigurationAssociations (new)

Link ¶

Lists the associations between code repositories and Amazon Inspector code security scan configurations.

See also: AWS API Documentation

Request Syntax

client.list_code_security_scan_configuration_associations(
    maxResults=123,
    nextToken='string',
    scanConfigurationArn='string'
)

type maxResults:

integer

param maxResults:

The maximum number of results to return in the response. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

type scanConfigurationArn:

string

param scanConfigurationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the scan configuration to list associations for.

rtype:

dict

returns:

Response Syntax

{
    'associations': [
        {
            'resource': {
                'projectId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- associations (list) --
  
  A list of associations between code repositories and scan configurations.
  - (dict) --
    
    A summary of an association between a code repository and a scan configuration.
    - resource (dict) --
      
      Identifies a specific resource in a code repository that will be scanned.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - projectId (string) --
        
        The unique identifier of the project in the code repository.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

ListCodeSecurityIntegrations (new)

Link ¶

Lists all code security integrations in your account.

See also: AWS API Documentation

Request Syntax

client.list_code_security_integrations(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

rtype:

dict

returns:

Response Syntax

{
    'integrations': [
        {
            'createdOn': datetime(2015, 1, 1),
            'integrationArn': 'string',
            'lastUpdateOn': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'INACTIVE'|'DISABLING',
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'GITLAB_SELF_MANAGED'|'GITHUB'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- integrations (list) --
  
  A list of code security integration summaries.
  - (dict) --
    
    A summary of information about a code security integration.
    - createdOn (datetime) --
      
      The timestamp when the code security integration was created.
    - integrationArn (string) --
      
      The Amazon Resource Name (ARN) of the code security integration.
    - lastUpdateOn (datetime) --
      
      The timestamp when the code security integration was last updated.
    - name (string) --
      
      The name of the code security integration.
    - status (string) --
      
      The current status of the code security integration.
    - statusReason (string) --
      
      The reason for the current status of the code security integration.
    - tags (dict) --
      
      The tags associated with the code security integration.
      - (string) --
        
        (string) --
    - type (string) --
      
      The type of repository provider for the integration.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

BatchAssociateCodeSecurityScanConfiguration (new)

Link ¶

Associates multiple code repositories with an Amazon Inspector code security scan configuration.

See also: AWS API Documentation

Request Syntax

client.batch_associate_code_security_scan_configuration(
    associateConfigurationRequests=[
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string'
        },
    ]
)

type associateConfigurationRequests:

list

param associateConfigurationRequests:

[REQUIRED]

A list of code repositories to associate with the specified scan configuration.

(dict) --

Contains details about a request to associate a code repository with a scan configuration.
- resource (dict) -- [REQUIRED]
  
  Identifies a specific resource in a code repository that will be scanned.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: projectId.
  - projectId (string) --
    
    The unique identifier of the project in the code repository.
- scanConfigurationArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the scan configuration.

rtype:

dict

returns:

Response Syntax

{
    'failedAssociations': [
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string',
            'statusCode': 'INTERNAL_ERROR'|'ACCESS_DENIED'|'SCAN_CONFIGURATION_NOT_FOUND'|'INVALID_INPUT'|'RESOURCE_NOT_FOUND'|'QUOTA_EXCEEDED',
            'statusMessage': 'string'
        },
    ],
    'successfulAssociations': [
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string'
        },
    ]
}

Response Structure

(dict) --
- failedAssociations (list) --
  
  Details of any code repositories that failed to be associated with the scan configuration.
  - (dict) --
    
    Details about a failed attempt to associate or disassociate a code repository with a scan configuration.
    - resource (dict) --
      
      Identifies a specific resource in a code repository that will be scanned.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - projectId (string) --
        
        The unique identifier of the project in the code repository.
    - scanConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the scan configuration that failed to be associated or disassociated.
    - statusCode (string) --
      
      The status code indicating why the association or disassociation failed.
    - statusMessage (string) --
      
      A message explaining why the association or disassociation failed.
- successfulAssociations (list) --
  
  Details of code repositories that were successfully associated with the scan configuration.
  - (dict) --
    
    Details about a successful association or disassociation between a code repository and a scan configuration.
    - resource (dict) --
      
      Identifies a specific resource in a code repository that will be scanned.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - projectId (string) --
        
        The unique identifier of the project in the code repository.
    - scanConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the scan configuration that was successfully associated or disassociated.

BatchDisassociateCodeSecurityScanConfiguration (new)

Link ¶

Disassociates multiple code repositories from an Amazon Inspector code security scan configuration.

See also: AWS API Documentation

Request Syntax

client.batch_disassociate_code_security_scan_configuration(
    disassociateConfigurationRequests=[
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string'
        },
    ]
)

type disassociateConfigurationRequests:

list

param disassociateConfigurationRequests:

[REQUIRED]

A list of code repositories to disassociate from the specified scan configuration.

(dict) --

Contains details about a request to disassociate a code repository from a scan configuration.
- resource (dict) -- [REQUIRED]
  
  Identifies a specific resource in a code repository that will be scanned.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: projectId.
  - projectId (string) --
    
    The unique identifier of the project in the code repository.
- scanConfigurationArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the scan configuration to disassociate from a code repository.

rtype:

dict

returns:

Response Syntax

{
    'failedAssociations': [
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string',
            'statusCode': 'INTERNAL_ERROR'|'ACCESS_DENIED'|'SCAN_CONFIGURATION_NOT_FOUND'|'INVALID_INPUT'|'RESOURCE_NOT_FOUND'|'QUOTA_EXCEEDED',
            'statusMessage': 'string'
        },
    ],
    'successfulAssociations': [
        {
            'resource': {
                'projectId': 'string'
            },
            'scanConfigurationArn': 'string'
        },
    ]
}

Response Structure

(dict) --
- failedAssociations (list) --
  
  Details of any code repositories that failed to be disassociated from the scan configuration.
  - (dict) --
    
    Details about a failed attempt to associate or disassociate a code repository with a scan configuration.
    - resource (dict) --
      
      Identifies a specific resource in a code repository that will be scanned.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - projectId (string) --
        
        The unique identifier of the project in the code repository.
    - scanConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the scan configuration that failed to be associated or disassociated.
    - statusCode (string) --
      
      The status code indicating why the association or disassociation failed.
    - statusMessage (string) --
      
      A message explaining why the association or disassociation failed.
- successfulAssociations (list) --
  
  Details of code repositories that were successfully disassociated from the scan configuration.
  - (dict) --
    
    Details about a successful association or disassociation between a code repository and a scan configuration.
    - resource (dict) --
      
      Identifies a specific resource in a code repository that will be scanned.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - projectId (string) --
        
        The unique identifier of the project in the code repository.
    - scanConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the scan configuration that was successfully associated or disassociated.

UpdateCodeSecurityIntegration (new)

Link ¶

Updates an existing code security integration.

After calling the CreateCodeSecurityIntegration operation, you complete authentication and authorization with your provider. Next you call the UpdateCodeSecurityIntegration operation to provide the details to complete the integration setup

See also: AWS API Documentation

Request Syntax

client.update_code_security_integration(
    details={
        'github': {
            'code': 'string',
            'installationId': 'string'
        },
        'gitlabSelfManaged': {
            'authCode': 'string'
        }
    },
    integrationArn='string'
)

type details:

dict

param details:

[REQUIRED]

The updated integration details specific to the repository provider type.

github (dict) --

Details specific to updating an integration with GitHub.
- code (string) -- [REQUIRED]
  
  The authorization code received from GitHub to update the integration.
- installationId (string) -- [REQUIRED]
  
  The installation ID of the GitHub App associated with the integration.
gitlabSelfManaged (dict) --

Details specific to updating an integration with a self-managed GitLab instance.
- authCode (string) -- [REQUIRED]
  
  The authorization code received from the self-managed GitLab instance to update the integration.

type integrationArn:

string

param integrationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the code security integration to update.

rtype:

dict

returns:

Response Syntax

{
    'integrationArn': 'string',
    'status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'INACTIVE'|'DISABLING'
}

Response Structure

(dict) --
- integrationArn (string) --
  
  The Amazon Resource Name (ARN) of the updated code security integration.
- status (string) --
  
  The current status of the updated code security integration.

DeleteCodeSecurityScanConfiguration (new)

Link ¶

Deletes a code security scan configuration.

See also: AWS API Documentation

Request Syntax

client.delete_code_security_scan_configuration(
    scanConfigurationArn='string'
)

type scanConfigurationArn:

string

param scanConfigurationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the scan configuration to delete.

rtype:

dict

returns:

Response Syntax

{
    'scanConfigurationArn': 'string'
}

Response Structure

(dict) --
- scanConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) of the deleted scan configuration.

GetCodeSecurityScan (new)

Link ¶

Retrieves information about a specific code security scan.

See also: AWS API Documentation

Request Syntax

client.get_code_security_scan(
    resource={
        'projectId': 'string'
    },
    scanId='string'
)

type resource:

dict

param resource:

[REQUIRED]

The resource identifier for the code repository that was scanned.

projectId (string) --

The unique identifier of the project in the code repository.

type scanId:

string

param scanId:

[REQUIRED]

The unique identifier of the scan to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'accountId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastCommitId': 'string',
    'resource': {
        'projectId': 'string'
    },
    'scanId': 'string',
    'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'SKIPPED',
    'statusReason': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- accountId (string) --
  
  The Amazon Web Services account ID associated with the scan.
- createdAt (datetime) --
  
  The timestamp when the scan was created.
- lastCommitId (string) --
  
  The identifier of the last commit that was scanned. This is only returned if the scan was successful or skipped.
- resource (dict) --
  
  The resource identifier for the code repository that was scanned.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: projectId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - projectId (string) --
    
    The unique identifier of the project in the code repository.
- scanId (string) --
  
  The unique identifier of the scan.
- status (string) --
  
  The current status of the scan.
- statusReason (string) --
  
  The reason for the current status of the scan.
- updatedAt (datetime) --
  
  The timestamp when the scan was last updated.

GetCodeSecurityIntegration (new)

Link ¶

Retrieves information about a code security integration.

See also: AWS API Documentation

Request Syntax

client.get_code_security_integration(
    integrationArn='string',
    tags={
        'string': 'string'
    }
)

type integrationArn:

string

param integrationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the code security integration to retrieve.

type tags:

dict

param tags:

The tags associated with the code security integration.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'authorizationUrl': 'string',
    'createdOn': datetime(2015, 1, 1),
    'integrationArn': 'string',
    'lastUpdateOn': datetime(2015, 1, 1),
    'name': 'string',
    'status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'INACTIVE'|'DISABLING',
    'statusReason': 'string',
    'tags': {
        'string': 'string'
    },
    'type': 'GITLAB_SELF_MANAGED'|'GITHUB'
}

Response Structure

(dict) --
- authorizationUrl (string) --
  
  The URL used to authorize the integration with the repository provider. This is only returned if reauthorization is required to fix a connection issue. Otherwise, it is null.
- createdOn (datetime) --
  
  The timestamp when the code security integration was created.
- integrationArn (string) --
  
  The Amazon Resource Name (ARN) of the code security integration.
- lastUpdateOn (datetime) --
  
  The timestamp when the code security integration was last updated.
- name (string) --
  
  The name of the code security integration.
- status (string) --
  
  The current status of the code security integration.
- statusReason (string) --
  
  The reason for the current status of the code security integration.
- tags (dict) --
  
  The tags associated with the code security integration.
  - (string) --
    - (string) --
- type (string) --
  
  The type of repository provider for the integration.

StartCodeSecurityScan (new)

Link ¶

Initiates a code security scan on a specified repository.

See also: AWS API Documentation

Request Syntax

client.start_code_security_scan(
    clientToken='string',
    resource={
        'projectId': 'string'
    }
)

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type resource:

dict

param resource:

[REQUIRED]

The resource identifier for the code repository to scan.

projectId (string) --

The unique identifier of the project in the code repository.

rtype:

dict

returns:

Response Syntax

{
    'scanId': 'string',
    'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'SKIPPED'
}

Response Structure

(dict) --
- scanId (string) --
  
  The unique identifier of the initiated scan.
- status (string) --
  
  The current status of the initiated scan.

CreateCodeSecurityIntegration (new)

Link ¶

Creates a code security integration with a source code repository provider.

See also: AWS API Documentation

Request Syntax

client.create_code_security_integration(
    details={
        'gitlabSelfManaged': {
            'accessToken': 'string',
            'instanceUrl': 'string'
        }
    },
    name='string',
    tags={
        'string': 'string'
    },
    type='GITLAB_SELF_MANAGED'|'GITHUB'
)

type details:

dict

param details:

The integration details specific to the repository provider type.

gitlabSelfManaged (dict) --

Details specific to creating an integration with a self-managed GitLab instance.
- accessToken (string) -- [REQUIRED]
  
  The personal access token used to authenticate with the self-managed GitLab instance.
- instanceUrl (string) -- [REQUIRED]
  
  The URL of the self-managed GitLab instance.

type name:

string

param name:

[REQUIRED]

The name of the code security integration.

type tags:

dict

param tags:

The tags to apply to the code security integration.

(string) --
- (string) --

type type:

string

param type:

[REQUIRED]

The type of repository provider for the integration.

rtype:

dict

returns:

Response Syntax

{
    'authorizationUrl': 'string',
    'integrationArn': 'string',
    'status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'INACTIVE'|'DISABLING'
}

Response Structure

(dict) --
- authorizationUrl (string) --
  
  The URL used to authorize the integration with the repository provider.
- integrationArn (string) --
  
  The Amazon Resource Name (ARN) of the created code security integration.
- status (string) --
  
  The current status of the code security integration.

BatchGetAccountStatus (updated)

Link ¶
Changes (response)

{'accounts': {'resourceState': {'codeRepository': {'errorCode': 'ALREADY_ENABLED '
                                                                '| '
                                                                'ENABLE_IN_PROGRESS '
                                                                '| '
                                                                'DISABLE_IN_PROGRESS '
                                                                '| '
                                                                'SUSPEND_IN_PROGRESS '
                                                                '| '
                                                                'RESOURCE_NOT_FOUND '
                                                                '| '
                                                                'ACCESS_DENIED '
                                                                '| '
                                                                'INTERNAL_ERROR '
                                                                '| '
                                                                'SSM_UNAVAILABLE '
                                                                '| '
                                                                'SSM_THROTTLED '
                                                                '| '
                                                                'EVENTBRIDGE_UNAVAILABLE '
                                                                '| '
                                                                'EVENTBRIDGE_THROTTLED '
                                                                '| '
                                                                'RESOURCE_SCAN_NOT_DISABLED '
                                                                '| '
                                                                'DISASSOCIATE_ALL_MEMBERS '
                                                                '| '
                                                                'ACCOUNT_IS_ISOLATED '
                                                                '| '
                                                                'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED '
                                                                '| '
                                                                'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                                                   'errorMessage': 'string',
                                                   'status': 'ENABLING | '
                                                             'ENABLED | '
                                                             'DISABLING | '
                                                             'DISABLED | '
                                                             'SUSPENDING | '
                                                             'SUSPENDED'}}},
 'failedAccounts': {'resourceStatus': {'codeRepository': 'ENABLING | ENABLED | '
                                                         'DISABLING | DISABLED '
                                                         '| SUSPENDING | '
                                                         'SUSPENDED'}}}

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

See also: AWS API Documentation

Request Syntax

client.batch_get_account_status(
    accountIds=[
        'string',
    ]
)

type accountIds:

list

param accountIds:

The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'accounts': [
        {
            'accountId': 'string',
            'resourceState': {
                'codeRepository': {
                    'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                    'errorMessage': 'string',
                    'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
                },
                'ec2': {
                    'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                    'errorMessage': 'string',
                    'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
                },
                'ecr': {
                    'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                    'errorMessage': 'string',
                    'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
                },
                'lambda': {
                    'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                    'errorMessage': 'string',
                    'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
                },
                'lambdaCode': {
                    'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                    'errorMessage': 'string',
                    'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
                }
            },
            'state': {
                'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
                'errorMessage': 'string',
                'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            }
        },
    ],
    'failedAccounts': [
        {
            'accountId': 'string',
            'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
            'errorMessage': 'string',
            'resourceStatus': {
                'codeRepository': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ec2': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ecr': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambda': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambdaCode': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            },
            'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
        },
    ]
}

Response Structure

(dict) --
- accounts (list) --
  
  An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.
  - (dict) --
    
    An object with details the status of an Amazon Web Services account within your Amazon Inspector environment.
    - accountId (string) --
      
      The Amazon Web Services account ID.
    - resourceState (dict) --
      
      An object detailing which resources Amazon Inspector is enabled to scan for the account.
      - codeRepository (dict) --
        
        An object that described the state of Amazon Inspector scans for an account.
        
        errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
        
        errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
        
        status (string) --
        
        The status of Amazon Inspector for the account.
      - ec2 (dict) --
        
        An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.
        
        errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
        
        errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
        
        status (string) --
        
        The status of Amazon Inspector for the account.
      - ecr (dict) --
        
        An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.
        
        errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
        
        errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
        
        status (string) --
        
        The status of Amazon Inspector for the account.
      - lambda (dict) --
        
        An object that described the state of Amazon Inspector scans for an account.
        
        errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
        
        errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
        
        status (string) --
        
        The status of Amazon Inspector for the account.
      - lambdaCode (dict) --
        
        An object that described the state of Amazon Inspector scans for an account.
        
        errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
        
        errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
        
        status (string) --
        
        The status of Amazon Inspector for the account.
    - state (dict) --
      
      An object detailing the status of Amazon Inspector for the account.
      - errorCode (string) --
        
        The error code explaining why the account failed to enable Amazon Inspector.
      - errorMessage (string) --
        
        The error message received when the account failed to enable Amazon Inspector.
      - status (string) --
        
        The status of Amazon Inspector for the account.
- failedAccounts (list) --
  
  An array of objects detailing any accounts that failed to enable Amazon Inspector and why.
  - (dict) --
    
    An object with details on why an account failed to enable Amazon Inspector.
    - accountId (string) --
      
      The Amazon Web Services account ID.
    - errorCode (string) --
      
      The error code explaining why the account failed to enable Amazon Inspector.
    - errorMessage (string) --
      
      The error message received when the account failed to enable Amazon Inspector.
    - resourceStatus (dict) --
      
      An object detailing which resources Amazon Inspector is enabled to scan for the account.
      - codeRepository (string) --
        
        The status of Amazon Inspector scanning for code repositories.
      - ec2 (string) --
        
        The status of Amazon Inspector scanning for Amazon EC2 resources.
      - ecr (string) --
        
        The status of Amazon Inspector scanning for Amazon ECR resources.
      - lambda (string) --
        
        The status of Amazon Inspector scanning for Amazon Web Services Lambda function.
      - lambdaCode (string) --
        
        The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
    - status (string) --
      
      The status of Amazon Inspector for the account.

BatchGetFreeTrialInfo (updated)

Link ¶
Changes (response)

{'accounts': {'freeTrialInfo': {'type': {'CODE_REPOSITORY'}}}}

Gets free trial status for multiple Amazon Web Services accounts.

See also: AWS API Documentation

Request Syntax

client.batch_get_free_trial_info(
    accountIds=[
        'string',
    ]
)

type accountIds:

list

param accountIds:

[REQUIRED]

The account IDs to get free trial status for.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'accounts': [
        {
            'accountId': 'string',
            'freeTrialInfo': [
                {
                    'end': datetime(2015, 1, 1),
                    'start': datetime(2015, 1, 1),
                    'status': 'ACTIVE'|'INACTIVE',
                    'type': 'EC2'|'ECR'|'LAMBDA'|'LAMBDA_CODE'|'CODE_REPOSITORY'
                },
            ]
        },
    ],
    'failedAccounts': [
        {
            'accountId': 'string',
            'code': 'ACCESS_DENIED'|'INTERNAL_ERROR',
            'message': 'string'
        },
    ]
}

Response Structure

(dict) --
- accounts (list) --
  
  An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.
  - (dict) --
    
    Information about the Amazon Inspector free trial for an account.
    - accountId (string) --
      
      The account associated with the Amazon Inspector free trial information.
    - freeTrialInfo (list) --
      
      Contains information about the Amazon Inspector free trial for an account.
      - (dict) --
        
        An object that contains information about the Amazon Inspector free trial for an account.
        
        end (datetime) --
        
        The date and time that the Amazon Inspector free trail ends for a given account.
        
        start (datetime) --
        
        The date and time that the Amazon Inspector free trail started for a given account.
        
        status (string) --
        
        The order to sort results by.
        
        type (string) --
        
        The type of scan covered by the Amazon Inspector free trail.
- failedAccounts (list) --
  
  An array of objects detailing any accounts that free trial data could not be returned for.
  - (dict) --
    
    Information about an error received while accessing free trail data for an account.
    - accountId (string) --
      
      The account associated with the Amazon Inspector free trial information.
    - code (string) --
      
      The error code.
    - message (string) --
      
      The error message returned.

CreateFilter (updated)

Link ¶
Changes (request)

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'PREFIX | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'PREFIX | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}]}}

Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.

See also: AWS API Documentation

Request Syntax

client.create_filter(
    action='NONE'|'SUPPRESS',
    description='string',
    filterCriteria={
        'awsAccountId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityFilePath': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceImageId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceSubnetId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceVpcId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageArchitecture': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageHash': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImagePushedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageRegistry': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageRepositoryName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'epssScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'exploitAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatus': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'firstObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'fixAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'inspectorScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'lambdaFunctionExecutionRoleArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionLastModifiedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionLayers': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lastObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'networkProtocol': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'portRange': [
            {
                'beginInclusive': 123,
                'endInclusive': 123
            },
        ],
        'relatedVulnerabilities': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'severity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'title': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'updatedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'vendorSeverity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilityId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilitySource': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerablePackages': [
            {
                'architecture': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'epoch': {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
                'filePath': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'name': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'release': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLambdaLayerArn': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLayerHash': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'version': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                }
            },
        ]
    },
    name='string',
    reason='string',
    tags={
        'string': 'string'
    }
)

type action:

string

param action:

[REQUIRED]

Defines the action that is to be applied to the findings that match the filter.

type description:

string

param description:

A description of the filter.

type filterCriteria:

dict

param filterCriteria:

[REQUIRED]

Defines the criteria to be used in the filter for querying findings.

awsAccountId (list) --

Details of the Amazon Web Services account IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProjectName (list) --

Filter criteria for findings based on the project name in a code repository.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProviderType (list) --

Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorName (list) --

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorTags (list) --

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityFilePath (list) --

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentId (list) --

Details of the component IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentType (list) --

Details of the component types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceImageId (list) --

Details of the Amazon EC2 instance image IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceSubnetId (list) --

Details of the Amazon EC2 instance subnet IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceVpcId (list) --

Details of the Amazon EC2 instance VPC IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageArchitecture (list) --

Details of the Amazon ECR image architecture types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageHash (list) --

Details of the Amazon ECR image hashes used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageInUseCount (list) --

Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
ecrImageLastInUseAt (list) --

Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImagePushedAt (list) --

Details on the Amazon ECR image push date and time used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImageRegistry (list) --

Details on the Amazon ECR registry used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageRepositoryName (list) --

Details on the name of the Amazon ECR repository used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageTags (list) --

The tags attached to the Amazon ECR container image.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
epssScore (list) --

The EPSS score used to filter findings.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
exploitAvailable (list) --

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingArn (list) --

Details on the finding ARNs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingStatus (list) --

Details on the finding status types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingType (list) --

Details on the finding types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
firstObservedAt (list) --

Details on the date and time a finding was first seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
fixAvailable (list) --

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
inspectorScore (list) --

The Amazon Inspector score to filter on.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
lambdaFunctionExecutionRoleArn (list) --

Filters the list of Amazon Web Services Lambda functions by execution role.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionLastModifiedAt (list) --

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
lambdaFunctionLayers (list) --

Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionName (list) --

Filters the list of Amazon Web Services Lambda functions by the name of the function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionRuntime (list) --

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lastObservedAt (list) --

Details on the date and time a finding was last seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
networkProtocol (list) --

Details on network protocol used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
portRange (list) --

Details on the port ranges used to filter findings.
- (dict) --
  
  An object that describes the details of a port range filter.
  - beginInclusive (integer) --
    
    The port number the port range begins at.
  - endInclusive (integer) --
    
    The port number the port range ends at.
relatedVulnerabilities (list) --

Details on the related vulnerabilities used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceId (list) --

Details on the resource IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceTags (list) --

Details on the resource tags used to filter findings.
- (dict) --
  
  An object that describes details of a map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - key (string) -- [REQUIRED]
    
    The tag key used in the filter.
  - value (string) --
    
    The tag value used in the filter.
resourceType (list) --

Details on the resource types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
severity (list) --

Details on the severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
title (list) --

Details on the finding title used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
updatedAt (list) --

Details on the date and time a finding was last updated at used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
vendorSeverity (list) --

Details on the vendor severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilityId (list) --

Details on the vulnerability ID used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilitySource (list) --

Details on the vulnerability type used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerablePackages (list) --

Details on the vulnerable packages used to filter findings.
- (dict) --
  
  Contains information on the details of a package filter.
  - architecture (dict) --
    
    An object that contains details on the package architecture type to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - epoch (dict) --
    
    An object that contains details on the package epoch to filter on.
    - lowerInclusive (float) --
      
      The lowest number to be included in the filter.
    - upperInclusive (float) --
      
      The highest number to be included in the filter.
  - filePath (dict) --
    
    An object that contains details on the package file path to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - name (dict) --
    
    An object that contains details on the name of the package to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - release (dict) --
    
    An object that contains details on the package release to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLambdaLayerArn (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLayerHash (dict) --
    
    An object that contains details on the source layer hash to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - version (dict) --
    
    The package version to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.

type name:

string

param name:

[REQUIRED]

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

type reason:

string

param reason:

The reason for creating the filter.

type tags:

dict

param tags:

A list of tags for the filter.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Number (ARN) of the successfully created filter.

CreateFindingsReport (updated)

Link ¶
Changes (request)

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'PREFIX | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'PREFIX | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}]}}

Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.

See also: AWS API Documentation

Request Syntax

client.create_findings_report(
    filterCriteria={
        'awsAccountId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityFilePath': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceImageId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceSubnetId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceVpcId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageArchitecture': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageHash': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImagePushedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageRegistry': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageRepositoryName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'epssScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'exploitAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatus': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'firstObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'fixAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'inspectorScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'lambdaFunctionExecutionRoleArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionLastModifiedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionLayers': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lastObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'networkProtocol': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'portRange': [
            {
                'beginInclusive': 123,
                'endInclusive': 123
            },
        ],
        'relatedVulnerabilities': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'severity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'title': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'updatedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'vendorSeverity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilityId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilitySource': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerablePackages': [
            {
                'architecture': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'epoch': {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
                'filePath': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'name': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'release': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLambdaLayerArn': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLayerHash': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'version': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                }
            },
        ]
    },
    reportFormat='CSV'|'JSON',
    s3Destination={
        'bucketName': 'string',
        'keyPrefix': 'string',
        'kmsKeyArn': 'string'
    }
)

type filterCriteria:

dict

param filterCriteria:

The filter criteria to apply to the results of the finding report.

awsAccountId (list) --

Details of the Amazon Web Services account IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProjectName (list) --

Filter criteria for findings based on the project name in a code repository.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProviderType (list) --

Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorName (list) --

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorTags (list) --

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityFilePath (list) --

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentId (list) --

Details of the component IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentType (list) --

Details of the component types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceImageId (list) --

Details of the Amazon EC2 instance image IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceSubnetId (list) --

Details of the Amazon EC2 instance subnet IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceVpcId (list) --

Details of the Amazon EC2 instance VPC IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageArchitecture (list) --

Details of the Amazon ECR image architecture types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageHash (list) --

Details of the Amazon ECR image hashes used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageInUseCount (list) --

Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
ecrImageLastInUseAt (list) --

Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImagePushedAt (list) --

Details on the Amazon ECR image push date and time used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImageRegistry (list) --

Details on the Amazon ECR registry used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageRepositoryName (list) --

Details on the name of the Amazon ECR repository used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageTags (list) --

The tags attached to the Amazon ECR container image.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
epssScore (list) --

The EPSS score used to filter findings.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
exploitAvailable (list) --

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingArn (list) --

Details on the finding ARNs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingStatus (list) --

Details on the finding status types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingType (list) --

Details on the finding types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
firstObservedAt (list) --

Details on the date and time a finding was first seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
fixAvailable (list) --

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
inspectorScore (list) --

The Amazon Inspector score to filter on.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
lambdaFunctionExecutionRoleArn (list) --

Filters the list of Amazon Web Services Lambda functions by execution role.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionLastModifiedAt (list) --

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
lambdaFunctionLayers (list) --

Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionName (list) --

Filters the list of Amazon Web Services Lambda functions by the name of the function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionRuntime (list) --

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lastObservedAt (list) --

Details on the date and time a finding was last seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
networkProtocol (list) --

Details on network protocol used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
portRange (list) --

Details on the port ranges used to filter findings.
- (dict) --
  
  An object that describes the details of a port range filter.
  - beginInclusive (integer) --
    
    The port number the port range begins at.
  - endInclusive (integer) --
    
    The port number the port range ends at.
relatedVulnerabilities (list) --

Details on the related vulnerabilities used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceId (list) --

Details on the resource IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceTags (list) --

Details on the resource tags used to filter findings.
- (dict) --
  
  An object that describes details of a map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - key (string) -- [REQUIRED]
    
    The tag key used in the filter.
  - value (string) --
    
    The tag value used in the filter.
resourceType (list) --

Details on the resource types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
severity (list) --

Details on the severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
title (list) --

Details on the finding title used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
updatedAt (list) --

Details on the date and time a finding was last updated at used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
vendorSeverity (list) --

Details on the vendor severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilityId (list) --

Details on the vulnerability ID used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilitySource (list) --

Details on the vulnerability type used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerablePackages (list) --

Details on the vulnerable packages used to filter findings.
- (dict) --
  
  Contains information on the details of a package filter.
  - architecture (dict) --
    
    An object that contains details on the package architecture type to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - epoch (dict) --
    
    An object that contains details on the package epoch to filter on.
    - lowerInclusive (float) --
      
      The lowest number to be included in the filter.
    - upperInclusive (float) --
      
      The highest number to be included in the filter.
  - filePath (dict) --
    
    An object that contains details on the package file path to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - name (dict) --
    
    An object that contains details on the name of the package to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - release (dict) --
    
    An object that contains details on the package release to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLambdaLayerArn (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLayerHash (dict) --
    
    An object that contains details on the source layer hash to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - version (dict) --
    
    The package version to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.

type reportFormat:

string

param reportFormat:

[REQUIRED]

The format to generate the report in.

type s3Destination:

dict

param s3Destination:

[REQUIRED]

The Amazon S3 export destination for the report.

bucketName (string) -- [REQUIRED]

The name of the Amazon S3 bucket to export findings to.
keyPrefix (string) --

The prefix that the findings will be written under.
kmsKeyArn (string) -- [REQUIRED]

The ARN of the KMS key used to encrypt data when exporting findings.

rtype:

dict

returns:

Response Syntax

{
    'reportId': 'string'
}

Response Structure

(dict) --
- reportId (string) --
  
  The ID of the report.

DescribeOrganizationConfiguration (updated)

Link ¶
Changes (response)

{'autoEnable': {'codeRepository': 'boolean'}}

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

See also: AWS API Documentation

Request Syntax

client.describe_organization_configuration()

rtype:

dict

returns:

Response Syntax

{
    'autoEnable': {
        'codeRepository': True|False,
        'ec2': True|False,
        'ecr': True|False,
        'lambda': True|False,
        'lambdaCode': True|False
    },
    'maxAccountLimitReached': True|False
}

Response Structure

(dict) --
- autoEnable (dict) --
  
  The scan types are automatically enabled for new members of your organization.
  - codeRepository (boolean) --
    
    Represents whether code repository scans are automatically enabled for new members of your Amazon Inspector organization.
  - ec2 (boolean) --
    
    Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.
  - ecr (boolean) --
    
    Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.
  - lambda (boolean) --
    
    Represents whether Amazon Web Services Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.
  - lambdaCode (boolean) --
    
    Represents whether Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.
- maxAccountLimitReached (boolean) --
  
  Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

Disable (updated)

Link ¶
Changes (request, response)
Request

{'resourceTypes': {'CODE_REPOSITORY'}}

Response

{'accounts': {'resourceStatus': {'codeRepository': 'ENABLING | ENABLED | '
                                                   'DISABLING | DISABLED | '
                                                   'SUSPENDING | SUSPENDED'}},
 'failedAccounts': {'resourceStatus': {'codeRepository': 'ENABLING | ENABLED | '
                                                         'DISABLING | DISABLED '
                                                         '| SUSPENDING | '
                                                         'SUSPENDED'}}}

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

See also: AWS API Documentation

Request Syntax

client.disable(
    accountIds=[
        'string',
    ],
    resourceTypes=[
        'EC2'|'ECR'|'LAMBDA'|'LAMBDA_CODE'|'CODE_REPOSITORY',
    ]
)

type accountIds:

list

param accountIds:

An array of account IDs you want to disable Amazon Inspector scans for.

(string) --

type resourceTypes:

list

param resourceTypes:

The resource scan types you want to disable.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'accounts': [
        {
            'accountId': 'string',
            'resourceStatus': {
                'codeRepository': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ec2': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ecr': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambda': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambdaCode': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            },
            'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
        },
    ],
    'failedAccounts': [
        {
            'accountId': 'string',
            'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
            'errorMessage': 'string',
            'resourceStatus': {
                'codeRepository': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ec2': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ecr': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambda': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambdaCode': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            },
            'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
        },
    ]
}

Response Structure

(dict) --
- accounts (list) --
  
  Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.
  - (dict) --
    
    An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.
    - accountId (string) --
      
      The ID of the Amazon Web Services account.
    - resourceStatus (dict) --
      
      Details of the status of Amazon Inspector scans by resource type.
      - codeRepository (string) --
        
        The status of Amazon Inspector scanning for code repositories.
      - ec2 (string) --
        
        The status of Amazon Inspector scanning for Amazon EC2 resources.
      - ecr (string) --
        
        The status of Amazon Inspector scanning for Amazon ECR resources.
      - lambda (string) --
        
        The status of Amazon Inspector scanning for Amazon Web Services Lambda function.
      - lambdaCode (string) --
        
        The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
    - status (string) --
      
      The status of Amazon Inspector for the account.
- failedAccounts (list) --
  
  Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.
  - (dict) --
    
    An object with details on why an account failed to enable Amazon Inspector.
    - accountId (string) --
      
      The Amazon Web Services account ID.
    - errorCode (string) --
      
      The error code explaining why the account failed to enable Amazon Inspector.
    - errorMessage (string) --
      
      The error message received when the account failed to enable Amazon Inspector.
    - resourceStatus (dict) --
      
      An object detailing which resources Amazon Inspector is enabled to scan for the account.
      - codeRepository (string) --
        
        The status of Amazon Inspector scanning for code repositories.
      - ec2 (string) --
        
        The status of Amazon Inspector scanning for Amazon EC2 resources.
      - ecr (string) --
        
        The status of Amazon Inspector scanning for Amazon ECR resources.
      - lambda (string) --
        
        The status of Amazon Inspector scanning for Amazon Web Services Lambda function.
      - lambdaCode (string) --
        
        The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
    - status (string) --
      
      The status of Amazon Inspector for the account.

Enable (updated)

Link ¶
Changes (request, response)
Request

{'resourceTypes': {'CODE_REPOSITORY'}}

Response

{'accounts': {'resourceStatus': {'codeRepository': 'ENABLING | ENABLED | '
                                                   'DISABLING | DISABLED | '
                                                   'SUSPENDING | SUSPENDED'}},
 'failedAccounts': {'resourceStatus': {'codeRepository': 'ENABLING | ENABLED | '
                                                         'DISABLING | DISABLED '
                                                         '| SUSPENDING | '
                                                         'SUSPENDED'}}}

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

See also: AWS API Documentation

Request Syntax

client.enable(
    accountIds=[
        'string',
    ],
    clientToken='string',
    resourceTypes=[
        'EC2'|'ECR'|'LAMBDA'|'LAMBDA_CODE'|'CODE_REPOSITORY',
    ]
)

type accountIds:

list

param accountIds:

A list of account IDs you want to enable Amazon Inspector scans for.

(string) --

type clientToken:

string

param clientToken:

The idempotency token for the request.

This field is autopopulated if not provided.

type resourceTypes:

list

param resourceTypes:

[REQUIRED]

The resource scan types you want to enable.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'accounts': [
        {
            'accountId': 'string',
            'resourceStatus': {
                'codeRepository': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ec2': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ecr': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambda': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambdaCode': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            },
            'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
        },
    ],
    'failedAccounts': [
        {
            'accountId': 'string',
            'errorCode': 'ALREADY_ENABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'SUSPEND_IN_PROGRESS'|'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'SSM_UNAVAILABLE'|'SSM_THROTTLED'|'EVENTBRIDGE_UNAVAILABLE'|'EVENTBRIDGE_THROTTLED'|'RESOURCE_SCAN_NOT_DISABLED'|'DISASSOCIATE_ALL_MEMBERS'|'ACCOUNT_IS_ISOLATED'|'EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED'|'EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED',
            'errorMessage': 'string',
            'resourceStatus': {
                'codeRepository': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ec2': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'ecr': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambda': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
                'lambdaCode': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
            },
            'status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED'
        },
    ]
}

Response Structure

(dict) --
- accounts (list) --
  
  Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.
  - (dict) --
    
    An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.
    - accountId (string) --
      
      The ID of the Amazon Web Services account.
    - resourceStatus (dict) --
      
      Details of the status of Amazon Inspector scans by resource type.
      - codeRepository (string) --
        
        The status of Amazon Inspector scanning for code repositories.
      - ec2 (string) --
        
        The status of Amazon Inspector scanning for Amazon EC2 resources.
      - ecr (string) --
        
        The status of Amazon Inspector scanning for Amazon ECR resources.
      - lambda (string) --
        
        The status of Amazon Inspector scanning for Amazon Web Services Lambda function.
      - lambdaCode (string) --
        
        The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
    - status (string) --
      
      The status of Amazon Inspector for the account.
- failedAccounts (list) --
  
  Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.
  - (dict) --
    
    An object with details on why an account failed to enable Amazon Inspector.
    - accountId (string) --
      
      The Amazon Web Services account ID.
    - errorCode (string) --
      
      The error code explaining why the account failed to enable Amazon Inspector.
    - errorMessage (string) --
      
      The error message received when the account failed to enable Amazon Inspector.
    - resourceStatus (dict) --
      
      An object detailing which resources Amazon Inspector is enabled to scan for the account.
      - codeRepository (string) --
        
        The status of Amazon Inspector scanning for code repositories.
      - ec2 (string) --
        
        The status of Amazon Inspector scanning for Amazon EC2 resources.
      - ecr (string) --
        
        The status of Amazon Inspector scanning for Amazon ECR resources.
      - lambda (string) --
        
        The status of Amazon Inspector scanning for Amazon Web Services Lambda function.
      - lambdaCode (string) --
        
        The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
    - status (string) --
      
      The status of Amazon Inspector for the account.

GetEncryptionKey (updated)

Link ¶
Changes (request)

{'resourceType': {'CODE_REPOSITORY'}}

Gets an encryption key.

See also: AWS API Documentation

Request Syntax

client.get_encryption_key(
    resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY',
    scanType='NETWORK'|'PACKAGE'|'CODE'
)

type resourceType:

string

param resourceType:

[REQUIRED]

The resource type the key encrypts.

type scanType:

string

param scanType:

[REQUIRED]

The scan type the key encrypts.

rtype:

dict

returns:

Response Syntax

{
    'kmsKeyId': 'string'
}

Response Structure

(dict) --
- kmsKeyId (string) --
  
  A kms key ID.

GetFindingsReportStatus (updated)

Link ¶
Changes (response)

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'PREFIX | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'PREFIX | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}]}}

Gets the status of a findings report.

See also: AWS API Documentation

Request Syntax

client.get_findings_report_status(
    reportId='string'
)

type reportId:

string

param reportId:

The ID of the report to retrieve the status of.

rtype:

dict

returns:

Response Syntax

{
    'destination': {
        'bucketName': 'string',
        'keyPrefix': 'string',
        'kmsKeyArn': 'string'
    },
    'errorCode': 'INTERNAL_ERROR'|'INVALID_PERMISSIONS'|'NO_FINDINGS_FOUND'|'BUCKET_NOT_FOUND'|'INCOMPATIBLE_BUCKET_REGION'|'MALFORMED_KMS_KEY',
    'errorMessage': 'string',
    'filterCriteria': {
        'awsAccountId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityFilePath': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceImageId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceSubnetId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceVpcId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageArchitecture': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageHash': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImagePushedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageRegistry': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageRepositoryName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'epssScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'exploitAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatus': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'firstObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'fixAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'inspectorScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'lambdaFunctionExecutionRoleArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionLastModifiedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionLayers': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lastObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'networkProtocol': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'portRange': [
            {
                'beginInclusive': 123,
                'endInclusive': 123
            },
        ],
        'relatedVulnerabilities': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'severity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'title': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'updatedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'vendorSeverity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilityId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilitySource': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerablePackages': [
            {
                'architecture': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'epoch': {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
                'filePath': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'name': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'release': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLambdaLayerArn': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLayerHash': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'version': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                }
            },
        ]
    },
    'reportId': 'string',
    'status': 'SUCCEEDED'|'IN_PROGRESS'|'CANCELLED'|'FAILED'
}

Response Structure

(dict) --
- destination (dict) --
  
  The destination of the report.
  - bucketName (string) --
    
    The name of the Amazon S3 bucket to export findings to.
  - keyPrefix (string) --
    
    The prefix that the findings will be written under.
  - kmsKeyArn (string) --
    
    The ARN of the KMS key used to encrypt data when exporting findings.
- errorCode (string) --
  
  The error code of the report.
- errorMessage (string) --
  
  The error message of the report.
- filterCriteria (dict) --
  
  The filter criteria associated with the report.
  - awsAccountId (list) --
    
    Details of the Amazon Web Services account IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - codeRepositoryProjectName (list) --
    
    Filter criteria for findings based on the project name in a code repository.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - codeRepositoryProviderType (list) --
    
    Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - codeVulnerabilityDetectorName (list) --
    
    The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - codeVulnerabilityDetectorTags (list) --
    
    The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - codeVulnerabilityFilePath (list) --
    
    The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - componentId (list) --
    
    Details of the component IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - componentType (list) --
    
    Details of the component types used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ec2InstanceImageId (list) --
    
    Details of the Amazon EC2 instance image IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ec2InstanceSubnetId (list) --
    
    Details of the Amazon EC2 instance subnet IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ec2InstanceVpcId (list) --
    
    Details of the Amazon EC2 instance VPC IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ecrImageArchitecture (list) --
    
    Details of the Amazon ECR image architecture types used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ecrImageHash (list) --
    
    Details of the Amazon ECR image hashes used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ecrImageInUseCount (list) --
    
    Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
    - (dict) --
      
      An object that describes the details of a number filter.
      - lowerInclusive (float) --
        
        The lowest number to be included in the filter.
      - upperInclusive (float) --
        
        The highest number to be included in the filter.
  - ecrImageLastInUseAt (list) --
    
    Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - ecrImagePushedAt (list) --
    
    Details on the Amazon ECR image push date and time used to filter findings.
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - ecrImageRegistry (list) --
    
    Details on the Amazon ECR registry used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ecrImageRepositoryName (list) --
    
    Details on the name of the Amazon ECR repository used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - ecrImageTags (list) --
    
    The tags attached to the Amazon ECR container image.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - epssScore (list) --
    
    The EPSS score used to filter findings.
    - (dict) --
      
      An object that describes the details of a number filter.
      - lowerInclusive (float) --
        
        The lowest number to be included in the filter.
      - upperInclusive (float) --
        
        The highest number to be included in the filter.
  - exploitAvailable (list) --
    
    Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - findingArn (list) --
    
    Details on the finding ARNs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - findingStatus (list) --
    
    Details on the finding status types used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - findingType (list) --
    
    Details on the finding types used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - firstObservedAt (list) --
    
    Details on the date and time a finding was first seen used to filter findings.
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - fixAvailable (list) --
    
    Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - inspectorScore (list) --
    
    The Amazon Inspector score to filter on.
    - (dict) --
      
      An object that describes the details of a number filter.
      - lowerInclusive (float) --
        
        The lowest number to be included in the filter.
      - upperInclusive (float) --
        
        The highest number to be included in the filter.
  - lambdaFunctionExecutionRoleArn (list) --
    
    Filters the list of Amazon Web Services Lambda functions by execution role.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - lambdaFunctionLastModifiedAt (list) --
    
    Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - lambdaFunctionLayers (list) --
    
    Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - lambdaFunctionName (list) --
    
    Filters the list of Amazon Web Services Lambda functions by the name of the function.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - lambdaFunctionRuntime (list) --
    
    Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - lastObservedAt (list) --
    
    Details on the date and time a finding was last seen used to filter findings.
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - networkProtocol (list) --
    
    Details on network protocol used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - portRange (list) --
    
    Details on the port ranges used to filter findings.
    - (dict) --
      
      An object that describes the details of a port range filter.
      - beginInclusive (integer) --
        
        The port number the port range begins at.
      - endInclusive (integer) --
        
        The port number the port range ends at.
  - relatedVulnerabilities (list) --
    
    Details on the related vulnerabilities used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - resourceId (list) --
    
    Details on the resource IDs used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - resourceTags (list) --
    
    Details on the resource tags used to filter findings.
    - (dict) --
      
      An object that describes details of a map filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - key (string) --
        
        The tag key used in the filter.
      - value (string) --
        
        The tag value used in the filter.
  - resourceType (list) --
    
    Details on the resource types used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - severity (list) --
    
    Details on the severity used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - title (list) --
    
    Details on the finding title used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - updatedAt (list) --
    
    Details on the date and time a finding was last updated at used to filter findings.
    - (dict) --
      
      Contains details on the time range used to filter findings.
      - endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
      - startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
  - vendorSeverity (list) --
    
    Details on the vendor severity used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - vulnerabilityId (list) --
    
    Details on the vulnerability ID used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - vulnerabilitySource (list) --
    
    Details on the vulnerability type used to filter findings.
    - (dict) --
      
      An object that describes the details of a string filter.
      - comparison (string) --
        
        The operator to use when comparing values in the filter.
      - value (string) --
        
        The value to filter on.
  - vulnerablePackages (list) --
    
    Details on the vulnerable packages used to filter findings.
    - (dict) --
      
      Contains information on the details of a package filter.
      - architecture (dict) --
        
        An object that contains details on the package architecture type to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - epoch (dict) --
        
        An object that contains details on the package epoch to filter on.
        
        lowerInclusive (float) --
        
        The lowest number to be included in the filter.
        
        upperInclusive (float) --
        
        The highest number to be included in the filter.
      - filePath (dict) --
        
        An object that contains details on the package file path to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - name (dict) --
        
        An object that contains details on the name of the package to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - release (dict) --
        
        An object that contains details on the package release to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - sourceLambdaLayerArn (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - sourceLayerHash (dict) --
        
        An object that contains details on the source layer hash to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - version (dict) --
        
        The package version to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
- reportId (string) --
  
  The ID of the report.
- status (string) --
  
  The status of the report.

ListCoverage (updated)

Link ¶
Changes (request, response)
Request

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}],
                    'codeRepositoryProviderTypeVisibility': [{'comparison': 'EQUALS '
                                                                            '| '
                                                                            'NOT_EQUALS',
                                                              'value': 'string'}],
                    'lastScannedCommitId': [{'comparison': 'EQUALS | '
                                                           'NOT_EQUALS',
                                             'value': 'string'}]}}

Response

{'coveredResources': {'resourceMetadata': {'codeRepository': {'integrationArn': 'string',
                                                              'lastScannedCommitId': 'string',
                                                              'onDemandScan': {'lastScanAt': 'timestamp',
                                                                               'lastScannedCommitId': 'string',
                                                                               'scanStatus': {'reason': 'PENDING_INITIAL_SCAN '
                                                                                                        '| '
                                                                                                        'ACCESS_DENIED '
                                                                                                        '| '
                                                                                                        'INTERNAL_ERROR '
                                                                                                        '| '
                                                                                                        'UNMANAGED_EC2_INSTANCE '
                                                                                                        '| '
                                                                                                        'UNSUPPORTED_OS '
                                                                                                        '| '
                                                                                                        'SCAN_ELIGIBILITY_EXPIRED '
                                                                                                        '| '
                                                                                                        'RESOURCE_TERMINATED '
                                                                                                        '| '
                                                                                                        'SUCCESSFUL '
                                                                                                        '| '
                                                                                                        'NO_RESOURCES_FOUND '
                                                                                                        '| '
                                                                                                        'IMAGE_SIZE_EXCEEDED '
                                                                                                        '| '
                                                                                                        'SCAN_FREQUENCY_MANUAL '
                                                                                                        '| '
                                                                                                        'SCAN_FREQUENCY_SCAN_ON_PUSH '
                                                                                                        '| '
                                                                                                        'EC2_INSTANCE_STOPPED '
                                                                                                        '| '
                                                                                                        'PENDING_DISABLE '
                                                                                                        '| '
                                                                                                        'NO_INVENTORY '
                                                                                                        '| '
                                                                                                        'STALE_INVENTORY '
                                                                                                        '| '
                                                                                                        'EXCLUDED_BY_TAG '
                                                                                                        '| '
                                                                                                        'UNSUPPORTED_RUNTIME '
                                                                                                        '| '
                                                                                                        'UNSUPPORTED_MEDIA_TYPE '
                                                                                                        '| '
                                                                                                        'UNSUPPORTED_CONFIG_FILE '
                                                                                                        '| '
                                                                                                        'DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED '
                                                                                                        '| '
                                                                                                        'DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED '
                                                                                                        '| '
                                                                                                        'DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED '
                                                                                                        '| '
                                                                                                        'DEEP_INSPECTION_NO_INVENTORY '
                                                                                                        '| '
                                                                                                        'AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED '
                                                                                                        '| '
                                                                                                        'AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED '
                                                                                                        '| '
                                                                                                        'PENDING_REVIVAL_SCAN '
                                                                                                        '| '
                                                                                                        'INTEGRATION_CONNECTION_LOST '
                                                                                                        '| '
                                                                                                        'ACCESS_DENIED_TO_ENCRYPTION_KEY '
                                                                                                        '| '
                                                                                                        'UNSUPPORTED_LANGUAGE '
                                                                                                        '| '
                                                                                                        'NO_SCAN_CONFIGURATION_ASSOCIATED '
                                                                                                        '| '
                                                                                                        'SCAN_IN_PROGRESS',
                                                                                              'statusCode': 'ACTIVE '
                                                                                                            '| '
                                                                                                            'INACTIVE'}},
                                                              'projectName': 'string',
                                                              'providerType': 'string',
                                                              'providerTypeVisibility': 'string',
                                                              'scanConfiguration': {'continuousIntegrationScanConfigurations': [{'ruleSetCategories': ['SAST '
                                                                                                                                                       '| '
                                                                                                                                                       'IAC '
                                                                                                                                                       '| '
                                                                                                                                                       'SCA'],
                                                                                                                                 'supportedEvent': 'PULL_REQUEST '
                                                                                                                                                   '| '
                                                                                                                                                   'PUSH'}],
                                                                                    'periodicScanConfigurations': [{'frequencyExpression': 'string',
                                                                                                                    'ruleSetCategories': ['SAST '
                                                                                                                                          '| '
                                                                                                                                          'IAC '
                                                                                                                                          '| '
                                                                                                                                          'SCA']}]}}},
                      'resourceType': {'CODE_REPOSITORY'},
                      'scanStatus': {'reason': {'ACCESS_DENIED_TO_ENCRYPTION_KEY',
                                                'INTEGRATION_CONNECTION_LOST',
                                                'NO_SCAN_CONFIGURATION_ASSOCIATED',
                                                'SCAN_IN_PROGRESS',
                                                'UNSUPPORTED_LANGUAGE'}}}}

Lists coverage details for your environment.

See also: AWS API Documentation

Request Syntax

client.list_coverage(
    filterCriteria={
        'accountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderTypeVisibility': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123,
                'upperInclusive': 123
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'imagePulledAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'lastScannedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lastScannedCommitId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanMode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusCode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusReason': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ]
    },
    maxResults=123,
    nextToken='string'
)

type filterCriteria:

dict

param filterCriteria:

An object that contains details on the filters to apply to the coverage data for your environment.

accountId (list) --

An array of Amazon Web Services account IDs to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProjectName (list) --

Filter criteria for code repositories based on project name.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProviderType (list) --

Filter criteria for code repositories based on provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProviderTypeVisibility (list) --

Filter criteria for code repositories based on visibility setting (public or private).
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
ec2InstanceTags (list) --

The Amazon EC2 instance tags to filter on.
- (dict) --
  
  Contains details of a coverage map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare coverage on.
  - key (string) -- [REQUIRED]
    
    The tag key associated with the coverage map filter.
  - value (string) --
    
    The tag value associated with the coverage map filter.
ecrImageInUseCount (list) --

The number of Amazon ECR images in use.
- (dict) --
  
  The coverage number to be used in the filter.
  - lowerInclusive (integer) --
    
    The lower inclusive for the coverage number.
  - upperInclusive (integer) --
    
    The upper inclusive for the coverage number.>
ecrImageLastInUseAt (list) --

The Amazon ECR image that was last in use.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
ecrImageTags (list) --

The Amazon ECR image tags to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
ecrRepositoryName (list) --

The Amazon ECR repository name to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
imagePulledAt (list) --

The date an image was last pulled at.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
lambdaFunctionName (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
lambdaFunctionRuntime (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
lambdaFunctionTags (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.
- (dict) --
  
  Contains details of a coverage map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare coverage on.
  - key (string) -- [REQUIRED]
    
    The tag key associated with the coverage map filter.
  - value (string) --
    
    The tag value associated with the coverage map filter.
lastScannedAt (list) --

Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
lastScannedCommitId (list) --

Filter criteria for code repositories based on the ID of the last scanned commit.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
resourceId (list) --

An array of Amazon Web Services resource IDs to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
resourceType (list) --

An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanMode (list) --

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_AGENTLESS.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanStatusCode (list) --

The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanStatusReason (list) --

The scan status reason to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanType (list) --

An array of Amazon Inspector scan types to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.

type maxResults:

integer

param maxResults:

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

rtype:

dict

returns:

Response Syntax

{
    'coveredResources': [
        {
            'accountId': 'string',
            'lastScannedAt': datetime(2015, 1, 1),
            'resourceId': 'string',
            'resourceMetadata': {
                'codeRepository': {
                    'integrationArn': 'string',
                    'lastScannedCommitId': 'string',
                    'onDemandScan': {
                        'lastScanAt': datetime(2015, 1, 1),
                        'lastScannedCommitId': 'string',
                        'scanStatus': {
                            'reason': 'PENDING_INITIAL_SCAN'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'UNMANAGED_EC2_INSTANCE'|'UNSUPPORTED_OS'|'SCAN_ELIGIBILITY_EXPIRED'|'RESOURCE_TERMINATED'|'SUCCESSFUL'|'NO_RESOURCES_FOUND'|'IMAGE_SIZE_EXCEEDED'|'SCAN_FREQUENCY_MANUAL'|'SCAN_FREQUENCY_SCAN_ON_PUSH'|'EC2_INSTANCE_STOPPED'|'PENDING_DISABLE'|'NO_INVENTORY'|'STALE_INVENTORY'|'EXCLUDED_BY_TAG'|'UNSUPPORTED_RUNTIME'|'UNSUPPORTED_MEDIA_TYPE'|'UNSUPPORTED_CONFIG_FILE'|'DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED'|'DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED'|'DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED'|'DEEP_INSPECTION_NO_INVENTORY'|'AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED'|'AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED'|'PENDING_REVIVAL_SCAN'|'INTEGRATION_CONNECTION_LOST'|'ACCESS_DENIED_TO_ENCRYPTION_KEY'|'UNSUPPORTED_LANGUAGE'|'NO_SCAN_CONFIGURATION_ASSOCIATED'|'SCAN_IN_PROGRESS',
                            'statusCode': 'ACTIVE'|'INACTIVE'
                        }
                    },
                    'projectName': 'string',
                    'providerType': 'string',
                    'providerTypeVisibility': 'string',
                    'scanConfiguration': {
                        'continuousIntegrationScanConfigurations': [
                            {
                                'ruleSetCategories': [
                                    'SAST'|'IAC'|'SCA',
                                ],
                                'supportedEvent': 'PULL_REQUEST'|'PUSH'
                            },
                        ],
                        'periodicScanConfigurations': [
                            {
                                'frequencyExpression': 'string',
                                'ruleSetCategories': [
                                    'SAST'|'IAC'|'SCA',
                                ]
                            },
                        ]
                    }
                },
                'ec2': {
                    'amiId': 'string',
                    'platform': 'WINDOWS'|'LINUX'|'UNKNOWN'|'MACOS',
                    'tags': {
                        'string': 'string'
                    }
                },
                'ecrImage': {
                    'imagePulledAt': datetime(2015, 1, 1),
                    'inUseCount': 123,
                    'lastInUseAt': datetime(2015, 1, 1),
                    'tags': [
                        'string',
                    ]
                },
                'ecrRepository': {
                    'name': 'string',
                    'scanFrequency': 'MANUAL'|'SCAN_ON_PUSH'|'CONTINUOUS_SCAN'
                },
                'lambdaFunction': {
                    'functionName': 'string',
                    'functionTags': {
                        'string': 'string'
                    },
                    'layers': [
                        'string',
                    ],
                    'runtime': 'NODEJS'|'NODEJS_12_X'|'NODEJS_14_X'|'NODEJS_16_X'|'JAVA_8'|'JAVA_8_AL2'|'JAVA_11'|'PYTHON_3_7'|'PYTHON_3_8'|'PYTHON_3_9'|'UNSUPPORTED'|'NODEJS_18_X'|'GO_1_X'|'JAVA_17'|'PYTHON_3_10'|'PYTHON_3_11'|'DOTNETCORE_3_1'|'DOTNET_6'|'DOTNET_7'|'RUBY_2_7'|'RUBY_3_2'
                }
            },
            'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY',
            'scanMode': 'EC2_SSM_AGENT_BASED'|'EC2_AGENTLESS',
            'scanStatus': {
                'reason': 'PENDING_INITIAL_SCAN'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'UNMANAGED_EC2_INSTANCE'|'UNSUPPORTED_OS'|'SCAN_ELIGIBILITY_EXPIRED'|'RESOURCE_TERMINATED'|'SUCCESSFUL'|'NO_RESOURCES_FOUND'|'IMAGE_SIZE_EXCEEDED'|'SCAN_FREQUENCY_MANUAL'|'SCAN_FREQUENCY_SCAN_ON_PUSH'|'EC2_INSTANCE_STOPPED'|'PENDING_DISABLE'|'NO_INVENTORY'|'STALE_INVENTORY'|'EXCLUDED_BY_TAG'|'UNSUPPORTED_RUNTIME'|'UNSUPPORTED_MEDIA_TYPE'|'UNSUPPORTED_CONFIG_FILE'|'DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED'|'DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED'|'DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED'|'DEEP_INSPECTION_NO_INVENTORY'|'AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED'|'AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED'|'PENDING_REVIVAL_SCAN'|'INTEGRATION_CONNECTION_LOST'|'ACCESS_DENIED_TO_ENCRYPTION_KEY'|'UNSUPPORTED_LANGUAGE'|'NO_SCAN_CONFIGURATION_ASSOCIATED'|'SCAN_IN_PROGRESS',
                'statusCode': 'ACTIVE'|'INACTIVE'
            },
            'scanType': 'NETWORK'|'PACKAGE'|'CODE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- coveredResources (list) --
  
  An object that contains details on the covered resources in your environment.
  - (dict) --
    
    An object that contains details about a resource covered by Amazon Inspector.
    - accountId (string) --
      
      The Amazon Web Services account ID of the covered resource.
    - lastScannedAt (datetime) --
      
      The date and time the resource was last checked for vulnerabilities.
    - resourceId (string) --
      
      The ID of the covered resource.
    - resourceMetadata (dict) --
      
      An object that contains details about the metadata.
      - codeRepository (dict) --
        
        Contains metadata about scan coverage for a code repository resource.
        
        integrationArn (string) --
        
        The Amazon Resource Name (ARN) of the code security integration associated with the repository.
        
        lastScannedCommitId (string) --
        
        The ID of the last commit that was scanned in the repository.
        
        onDemandScan (dict) --
        
        Information about on-demand scans performed on the repository.
        
        lastScanAt (datetime) --
        
        The timestamp when the last on-demand scan was performed.
        
        lastScannedCommitId (string) --
        
        The ID of the last commit that was scanned during an on-demand scan.
        
        scanStatus (dict) --
        
        The status of the scan.
        
        reason (string) --
        
        The scan status. Possible return values and descriptions are:
        
        ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.
        
        ACCESS_DENIED_TO_ENCRYPTION_KEY - The KMS key policy doesn't allow Amazon Inspector access. Update the key policy.
        
        DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.
        
        DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.
        
        DEEP_INSPECTION_NO_INVENTORY - The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.
        
        DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.
        
        EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it's in a stopped state.
        
        EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.
        
        IMAGE_SIZE_EXCEEDED - Reserved for future use.
        
        INTEGRATION_CONNNECTION_LOST - Amazon Inspector couldn't communicate with the source code management platform.
        
        INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.
        
        NO INVENTORY - Amazon Inspector couldn't find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance's inventory in the SSM Fleet Manager console.
        
        NO_RESOURCES_FOUND - Reserved for future use.
        
        NO_SCAN_CONFIGURATION_ASSOCIATED - The code repository resource doesn't have an associated scan configuration.
        
        PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.
        
        PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.
        
        RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.
        
        SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.
        
        SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.
        
        SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.
        
        SCAN_IN_PROGRESS - The resource is currently being scanned.
        
        STALE_INVENTORY - Amazon Inspector wasn't able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.
        
        SUCCESSFUL - The scan was successful.
        
        UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.
        
        UNSUPPORTED_CONFIG_FILE - Reserved for future use.
        
        UNSUPPORTED_LANGUAGE - The scan was unsuccessful because the repository contains files in an unsupported programming language.
        
        ``UNSUPPORTED_MEDIA_TYPE ``- The ECR image has an unsupported media type.
        
        UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.
        
        UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.
        
        statusCode (string) --
        
        The status code of the scan.
        
        projectName (string) --
        
        The name of the project in the code repository.
        
        providerType (string) --
        
        The type of repository provider (such as GitHub, GitLab, etc.).
        
        providerTypeVisibility (string) --
        
        The visibility setting of the repository (public or private).
        
        scanConfiguration (dict) --
        
        The scan configuration settings applied to the code repository.
        
        continuousIntegrationScanConfigurations (list) --
        
        The continuous integration scan configurations applied to the project.
        
        (dict) --
        
        Contains the continuous integration scan configuration settings applied to a specific project.
        
        ruleSetCategories (list) --
        
        The categories of security rules applied during continuous integration scans for the project.
        
        (string) --
        
        supportedEvent (string) --
        
        The repository event that triggers continuous integration scans for the project.
        
        periodicScanConfigurations (list) --
        
        The periodic scan configurations applied to the project.
        
        (dict) --
        
        Contains the periodic scan configuration settings applied to a specific project.
        
        frequencyExpression (string) --
        
        The schedule expression for periodic scans, in cron format, applied to the project.
        
        ruleSetCategories (list) --
        
        The categories of security rules applied during periodic scans for the project.
        
        (string) --
      - ec2 (dict) --
        
        An object that contains metadata details for an Amazon EC2 instance.
        
        amiId (string) --
        
        The ID of the Amazon Machine Image (AMI) used to launch the instance.
        
        platform (string) --
        
        The platform of the instance.
        
        tags (dict) --
        
        The tags attached to the instance.
        
        (string) --
        
        (string) --
      - ecrImage (dict) --
        
        An object that contains details about the container metadata for an Amazon ECR image.
        
        imagePulledAt (datetime) --
        
        The date an image was last pulled at.
        
        inUseCount (integer) --
        
        The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
        
        lastInUseAt (datetime) --
        
        The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
        
        tags (list) --
        
        Tags associated with the Amazon ECR image metadata.
        
        (string) --
      - ecrRepository (dict) --
        
        An object that contains details about the repository an Amazon ECR image resides in.
        
        name (string) --
        
        The name of the Amazon ECR repository.
        
        scanFrequency (string) --
        
        The frequency of scans.
      - lambdaFunction (dict) --
        
        An object that contains metadata details for an Amazon Web Services Lambda function.
        
        functionName (string) --
        
        The name of a function.
        
        functionTags (dict) --
        
        The resource tags on an Amazon Web Services Lambda function.
        
        (string) --
        
        (string) --
        
        layers (list) --
        
        The layers for an Amazon Web Services Lambda function. A Lambda function can have up to five layers.
        
        (string) --
        
        runtime (string) --
        
        An Amazon Web Services Lambda function's runtime.
    - resourceType (string) --
      
      The type of the covered resource.
    - scanMode (string) --
      
      The scan method that is applied to the instance.
    - scanStatus (dict) --
      
      The status of the scan covering the resource.
      - reason (string) --
        
        The scan status. Possible return values and descriptions are:
        
        ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.
        
        ACCESS_DENIED_TO_ENCRYPTION_KEY - The KMS key policy doesn't allow Amazon Inspector access. Update the key policy.
        
        DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.
        
        DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.
        
        DEEP_INSPECTION_NO_INVENTORY - The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.
        
        DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.
        
        EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it's in a stopped state.
        
        EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.
        
        IMAGE_SIZE_EXCEEDED - Reserved for future use.
        
        INTEGRATION_CONNNECTION_LOST - Amazon Inspector couldn't communicate with the source code management platform.
        
        INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.
        
        NO INVENTORY - Amazon Inspector couldn't find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance's inventory in the SSM Fleet Manager console.
        
        NO_RESOURCES_FOUND - Reserved for future use.
        
        NO_SCAN_CONFIGURATION_ASSOCIATED - The code repository resource doesn't have an associated scan configuration.
        
        PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.
        
        PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.
        
        RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.
        
        SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.
        
        SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.
        
        SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.
        
        SCAN_IN_PROGRESS - The resource is currently being scanned.
        
        STALE_INVENTORY - Amazon Inspector wasn't able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.
        
        SUCCESSFUL - The scan was successful.
        
        UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.
        
        UNSUPPORTED_CONFIG_FILE - Reserved for future use.
        
        UNSUPPORTED_LANGUAGE - The scan was unsuccessful because the repository contains files in an unsupported programming language.
        
        ``UNSUPPORTED_MEDIA_TYPE ``- The ECR image has an unsupported media type.
        
        UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.
        
        UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.
      - statusCode (string) --
        
        The status code of the scan.
    - scanType (string) --
      
      The Amazon Inspector scan type covering the resource.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

ListCoverageStatistics (updated)

Link ¶
Changes (request)

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}],
                    'codeRepositoryProviderTypeVisibility': [{'comparison': 'EQUALS '
                                                                            '| '
                                                                            'NOT_EQUALS',
                                                              'value': 'string'}],
                    'lastScannedCommitId': [{'comparison': 'EQUALS | '
                                                           'NOT_EQUALS',
                                             'value': 'string'}]}}

Lists Amazon Inspector coverage statistics for your environment.

See also: AWS API Documentation

Request Syntax

client.list_coverage_statistics(
    filterCriteria={
        'accountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderTypeVisibility': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123,
                'upperInclusive': 123
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'imagePulledAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'lastScannedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lastScannedCommitId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanMode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusCode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusReason': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ]
    },
    groupBy='SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME',
    nextToken='string'
)

type filterCriteria:

dict

param filterCriteria:

An object that contains details on the filters to apply to the coverage data for your environment.

accountId (list) --

An array of Amazon Web Services account IDs to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProjectName (list) --

Filter criteria for code repositories based on project name.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProviderType (list) --

Filter criteria for code repositories based on provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
codeRepositoryProviderTypeVisibility (list) --

Filter criteria for code repositories based on visibility setting (public or private).
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
ec2InstanceTags (list) --

The Amazon EC2 instance tags to filter on.
- (dict) --
  
  Contains details of a coverage map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare coverage on.
  - key (string) -- [REQUIRED]
    
    The tag key associated with the coverage map filter.
  - value (string) --
    
    The tag value associated with the coverage map filter.
ecrImageInUseCount (list) --

The number of Amazon ECR images in use.
- (dict) --
  
  The coverage number to be used in the filter.
  - lowerInclusive (integer) --
    
    The lower inclusive for the coverage number.
  - upperInclusive (integer) --
    
    The upper inclusive for the coverage number.>
ecrImageLastInUseAt (list) --

The Amazon ECR image that was last in use.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
ecrImageTags (list) --

The Amazon ECR image tags to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
ecrRepositoryName (list) --

The Amazon ECR repository name to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
imagePulledAt (list) --

The date an image was last pulled at.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
lambdaFunctionName (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
lambdaFunctionRuntime (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
lambdaFunctionTags (list) --

Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.
- (dict) --
  
  Contains details of a coverage map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare coverage on.
  - key (string) -- [REQUIRED]
    
    The tag key associated with the coverage map filter.
  - value (string) --
    
    The tag value associated with the coverage map filter.
lastScannedAt (list) --

Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.
- (dict) --
  
  Contains details of a coverage date filter.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period to filter results by.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period to filter results by.
lastScannedCommitId (list) --

Filter criteria for code repositories based on the ID of the last scanned commit.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
resourceId (list) --

An array of Amazon Web Services resource IDs to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
resourceType (list) --

An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanMode (list) --

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_AGENTLESS.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanStatusCode (list) --

The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanStatusReason (list) --

The scan status reason to filter on.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.
scanType (list) --

An array of Amazon Inspector scan types to return coverage statistics for.
- (dict) --
  
  Contains details of a coverage string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to compare strings on.
  - value (string) -- [REQUIRED]
    
    The value to compare strings on.

type groupBy:

string

param groupBy:

The value to group the results by.

type nextToken:

string

param nextToken:

rtype:

dict

returns:

Response Syntax

{
    'countsByGroup': [
        {
            'count': 123,
            'groupKey': 'SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME'
        },
    ],
    'nextToken': 'string',
    'totalCounts': 123
}

Response Structure

(dict) --
- countsByGroup (list) --
  
  An array with the number for each group.
  - (dict) --
    
    a structure that contains information on the count of resources within a group.
    - count (integer) --
      
      The number of resources.
    - groupKey (string) --
      
      The key associated with this group
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
- totalCounts (integer) --
  
  The total number for all groups.

ListFilters (updated)

Link ¶
Changes (response)

{'filters': {'criteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS '
                                                                       '| '
                                                                       'PREFIX '
                                                                       '| '
                                                                       'NOT_EQUALS',
                                                         'value': 'string'}],
                          'codeRepositoryProviderType': [{'comparison': 'EQUALS '
                                                                        '| '
                                                                        'PREFIX '
                                                                        '| '
                                                                        'NOT_EQUALS',
                                                          'value': 'string'}]}}}

Lists the filters associated with your account.

See also: AWS API Documentation

Request Syntax

client.list_filters(
    action='NONE'|'SUPPRESS',
    arns=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

type action:

string

param action:

The action the filter applies to matched findings.

type arns:

list

param arns:

The Amazon resource number (ARN) of the filter.

(string) --

type maxResults:

integer

param maxResults:

type nextToken:

string

param nextToken:

rtype:

dict

returns:

Response Syntax

{
    'filters': [
        {
            'action': 'NONE'|'SUPPRESS',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'criteria': {
                'awsAccountId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'codeRepositoryProjectName': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'codeRepositoryProviderType': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'codeVulnerabilityDetectorName': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'codeVulnerabilityDetectorTags': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'codeVulnerabilityFilePath': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'componentId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'componentType': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ec2InstanceImageId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ec2InstanceSubnetId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ec2InstanceVpcId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ecrImageArchitecture': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ecrImageHash': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ecrImageInUseCount': [
                    {
                        'lowerInclusive': 123.0,
                        'upperInclusive': 123.0
                    },
                ],
                'ecrImageLastInUseAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'ecrImagePushedAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'ecrImageRegistry': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ecrImageRepositoryName': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'ecrImageTags': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'epssScore': [
                    {
                        'lowerInclusive': 123.0,
                        'upperInclusive': 123.0
                    },
                ],
                'exploitAvailable': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'findingArn': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'findingStatus': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'findingType': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'firstObservedAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'fixAvailable': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'inspectorScore': [
                    {
                        'lowerInclusive': 123.0,
                        'upperInclusive': 123.0
                    },
                ],
                'lambdaFunctionExecutionRoleArn': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'lambdaFunctionLastModifiedAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'lambdaFunctionLayers': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'lambdaFunctionName': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'lambdaFunctionRuntime': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'lastObservedAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'networkProtocol': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'portRange': [
                    {
                        'beginInclusive': 123,
                        'endInclusive': 123
                    },
                ],
                'relatedVulnerabilities': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'resourceId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'resourceTags': [
                    {
                        'comparison': 'EQUALS',
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'resourceType': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'severity': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'title': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'updatedAt': [
                    {
                        'endInclusive': datetime(2015, 1, 1),
                        'startInclusive': datetime(2015, 1, 1)
                    },
                ],
                'vendorSeverity': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'vulnerabilityId': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'vulnerabilitySource': [
                    {
                        'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                        'value': 'string'
                    },
                ],
                'vulnerablePackages': [
                    {
                        'architecture': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'epoch': {
                            'lowerInclusive': 123.0,
                            'upperInclusive': 123.0
                        },
                        'filePath': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'name': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'release': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'sourceLambdaLayerArn': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'sourceLayerHash': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        },
                        'version': {
                            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                            'value': 'string'
                        }
                    },
                ]
            },
            'description': 'string',
            'name': 'string',
            'ownerId': 'string',
            'reason': 'string',
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- filters (list) --
  
  Contains details on the filters associated with your account.
  - (dict) --
    
    Details about a filter.
    - action (string) --
      
      The action that is to be applied to the findings that match the filter.
    - arn (string) --
      
      The Amazon Resource Number (ARN) associated with this filter.
    - createdAt (datetime) --
      
      The date and time this filter was created at.
    - criteria (dict) --
      
      Details on the filter criteria associated with this filter.
      - awsAccountId (list) --
        
        Details of the Amazon Web Services account IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - codeRepositoryProjectName (list) --
        
        Filter criteria for findings based on the project name in a code repository.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - codeRepositoryProviderType (list) --
        
        Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - codeVulnerabilityDetectorName (list) --
        
        The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - codeVulnerabilityDetectorTags (list) --
        
        The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - codeVulnerabilityFilePath (list) --
        
        The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - componentId (list) --
        
        Details of the component IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - componentType (list) --
        
        Details of the component types used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ec2InstanceImageId (list) --
        
        Details of the Amazon EC2 instance image IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ec2InstanceSubnetId (list) --
        
        Details of the Amazon EC2 instance subnet IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ec2InstanceVpcId (list) --
        
        Details of the Amazon EC2 instance VPC IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ecrImageArchitecture (list) --
        
        Details of the Amazon ECR image architecture types used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ecrImageHash (list) --
        
        Details of the Amazon ECR image hashes used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ecrImageInUseCount (list) --
        
        Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
        
        (dict) --
        
        An object that describes the details of a number filter.
        
        lowerInclusive (float) --
        
        The lowest number to be included in the filter.
        
        upperInclusive (float) --
        
        The highest number to be included in the filter.
      - ecrImageLastInUseAt (list) --
        
        Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - ecrImagePushedAt (list) --
        
        Details on the Amazon ECR image push date and time used to filter findings.
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - ecrImageRegistry (list) --
        
        Details on the Amazon ECR registry used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ecrImageRepositoryName (list) --
        
        Details on the name of the Amazon ECR repository used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - ecrImageTags (list) --
        
        The tags attached to the Amazon ECR container image.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - epssScore (list) --
        
        The EPSS score used to filter findings.
        
        (dict) --
        
        An object that describes the details of a number filter.
        
        lowerInclusive (float) --
        
        The lowest number to be included in the filter.
        
        upperInclusive (float) --
        
        The highest number to be included in the filter.
      - exploitAvailable (list) --
        
        Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - findingArn (list) --
        
        Details on the finding ARNs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - findingStatus (list) --
        
        Details on the finding status types used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - findingType (list) --
        
        Details on the finding types used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - firstObservedAt (list) --
        
        Details on the date and time a finding was first seen used to filter findings.
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - fixAvailable (list) --
        
        Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - inspectorScore (list) --
        
        The Amazon Inspector score to filter on.
        
        (dict) --
        
        An object that describes the details of a number filter.
        
        lowerInclusive (float) --
        
        The lowest number to be included in the filter.
        
        upperInclusive (float) --
        
        The highest number to be included in the filter.
      - lambdaFunctionExecutionRoleArn (list) --
        
        Filters the list of Amazon Web Services Lambda functions by execution role.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - lambdaFunctionLastModifiedAt (list) --
        
        Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - lambdaFunctionLayers (list) --
        
        Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - lambdaFunctionName (list) --
        
        Filters the list of Amazon Web Services Lambda functions by the name of the function.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - lambdaFunctionRuntime (list) --
        
        Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - lastObservedAt (list) --
        
        Details on the date and time a finding was last seen used to filter findings.
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - networkProtocol (list) --
        
        Details on network protocol used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - portRange (list) --
        
        Details on the port ranges used to filter findings.
        
        (dict) --
        
        An object that describes the details of a port range filter.
        
        beginInclusive (integer) --
        
        The port number the port range begins at.
        
        endInclusive (integer) --
        
        The port number the port range ends at.
      - relatedVulnerabilities (list) --
        
        Details on the related vulnerabilities used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - resourceId (list) --
        
        Details on the resource IDs used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - resourceTags (list) --
        
        Details on the resource tags used to filter findings.
        
        (dict) --
        
        An object that describes details of a map filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        key (string) --
        
        The tag key used in the filter.
        
        value (string) --
        
        The tag value used in the filter.
      - resourceType (list) --
        
        Details on the resource types used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - severity (list) --
        
        Details on the severity used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - title (list) --
        
        Details on the finding title used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - updatedAt (list) --
        
        Details on the date and time a finding was last updated at used to filter findings.
        
        (dict) --
        
        Contains details on the time range used to filter findings.
        
        endInclusive (datetime) --
        
        A timestamp representing the end of the time period filtered on.
        
        startInclusive (datetime) --
        
        A timestamp representing the start of the time period filtered on.
      - vendorSeverity (list) --
        
        Details on the vendor severity used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - vulnerabilityId (list) --
        
        Details on the vulnerability ID used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - vulnerabilitySource (list) --
        
        Details on the vulnerability type used to filter findings.
        
        (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
      - vulnerablePackages (list) --
        
        Details on the vulnerable packages used to filter findings.
        
        (dict) --
        
        Contains information on the details of a package filter.
        
        architecture (dict) --
        
        An object that contains details on the package architecture type to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        epoch (dict) --
        
        An object that contains details on the package epoch to filter on.
        
        lowerInclusive (float) --
        
        The lowest number to be included in the filter.
        
        upperInclusive (float) --
        
        The highest number to be included in the filter.
        
        filePath (dict) --
        
        An object that contains details on the package file path to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        name (dict) --
        
        An object that contains details on the name of the package to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        release (dict) --
        
        An object that contains details on the package release to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        sourceLambdaLayerArn (dict) --
        
        An object that describes the details of a string filter.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        sourceLayerHash (dict) --
        
        An object that contains details on the source layer hash to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
        
        version (dict) --
        
        The package version to filter on.
        
        comparison (string) --
        
        The operator to use when comparing values in the filter.
        
        value (string) --
        
        The value to filter on.
    - description (string) --
      
      A description of the filter.
    - name (string) --
      
      The name of the filter.
    - ownerId (string) --
      
      The Amazon Web Services account ID of the account that created the filter.
    - reason (string) --
      
      The reason for the filter.
    - tags (dict) --
      
      The tags attached to the filter.
      - (string) --
        
        (string) --
    - updatedAt (datetime) --
      
      The date and time the filter was last updated at.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

ListFindingAggregations (updated)

Link ¶
Changes (request, response)
Request

{'aggregationRequest': {'codeRepositoryAggregation': {'projectNames': [{'comparison': 'EQUALS '
                                                                                      '| '
                                                                                      'PREFIX '
                                                                                      '| '
                                                                                      'NOT_EQUALS',
                                                                        'value': 'string'}],
                                                      'providerTypes': [{'comparison': 'EQUALS '
                                                                                       '| '
                                                                                       'PREFIX '
                                                                                       '| '
                                                                                       'NOT_EQUALS',
                                                                         'value': 'string'}],
                                                      'resourceIds': [{'comparison': 'EQUALS '
                                                                                     '| '
                                                                                     'PREFIX '
                                                                                     '| '
                                                                                     'NOT_EQUALS',
                                                                       'value': 'string'}],
                                                      'sortBy': 'CRITICAL | '
                                                                'HIGH | ALL',
                                                      'sortOrder': 'ASC | '
                                                                   'DESC'}},
 'aggregationType': {'CODE_REPOSITORY'}}

Response

{'aggregationType': {'CODE_REPOSITORY'},
 'responses': {'codeRepositoryAggregation': {'accountId': 'string',
                                             'exploitAvailableActiveFindingsCount': 'long',
                                             'fixAvailableActiveFindingsCount': 'long',
                                             'projectNames': 'string',
                                             'providerType': 'string',
                                             'resourceId': 'string',
                                             'severityCounts': {'all': 'long',
                                                                'critical': 'long',
                                                                'high': 'long',
                                                                'medium': 'long'}}}}

Lists aggregated finding data for your environment based on specific criteria.

See also: AWS API Documentation

Request Syntax

client.list_finding_aggregations(
    accountIds=[
        {
            'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
            'value': 'string'
        },
    ],
    aggregationRequest={
        'accountAggregation': {
            'findingType': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
            'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_LAMBDA_FUNCTION',
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'amiAggregation': {
            'amis': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL'|'AFFECTED_INSTANCES',
            'sortOrder': 'ASC'|'DESC'
        },
        'awsEcrContainerAggregation': {
            'architectures': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'imageShas': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'imageTags': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'inUseCount': [
                {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
            ],
            'lastInUseAt': [
                {
                    'endInclusive': datetime(2015, 1, 1),
                    'startInclusive': datetime(2015, 1, 1)
                },
            ],
            'repositories': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'codeRepositoryAggregation': {
            'projectNames': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'providerTypes': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'ec2InstanceAggregation': {
            'amis': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'instanceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'instanceTags': [
                {
                    'comparison': 'EQUALS',
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'operatingSystems': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'NETWORK_FINDINGS'|'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'findingTypeAggregation': {
            'findingType': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
            'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_LAMBDA_FUNCTION',
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'imageLayerAggregation': {
            'layerHashes': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'repositories': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'lambdaFunctionAggregation': {
            'functionNames': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'functionTags': [
                {
                    'comparison': 'EQUALS',
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'resourceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'runtimes': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'lambdaLayerAggregation': {
            'functionNames': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'layerArns': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'packageAggregation': {
            'packageNames': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC'
        },
        'repositoryAggregation': {
            'repositories': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'sortBy': 'CRITICAL'|'HIGH'|'ALL'|'AFFECTED_IMAGES',
            'sortOrder': 'ASC'|'DESC'
        },
        'titleAggregation': {
            'findingType': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
            'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_LAMBDA_FUNCTION',
            'sortBy': 'CRITICAL'|'HIGH'|'ALL',
            'sortOrder': 'ASC'|'DESC',
            'titles': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'vulnerabilityIds': [
                {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
            ]
        }
    },
    aggregationType='FINDING_TYPE'|'PACKAGE'|'TITLE'|'REPOSITORY'|'AMI'|'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER'|'IMAGE_LAYER'|'ACCOUNT'|'AWS_LAMBDA_FUNCTION'|'LAMBDA_LAYER'|'CODE_REPOSITORY',
    maxResults=123,
    nextToken='string'
)

type accountIds:

list

param accountIds:

The Amazon Web Services account IDs to retrieve finding aggregation data for.

(dict) --

An object that describes the details of a string filter.
- comparison (string) -- [REQUIRED]
  
  The operator to use when comparing values in the filter.
- value (string) -- [REQUIRED]
  
  The value to filter on.

type aggregationRequest:

dict

param aggregationRequest:

Details of the aggregation request that is used to filter your aggregation results.

accountAggregation (dict) --

An object that contains details about an aggregation request based on Amazon Web Services account IDs.
- findingType (string) --
  
  The type of finding.
- resourceType (string) --
  
  The type of resource.
- sortBy (string) --
  
  The value to sort by.
- sortOrder (string) --
  
  The sort order (ascending or descending).
amiAggregation (dict) --

An object that contains details about an aggregation request based on Amazon Machine Images (AMIs).
- amis (list) --
  
  The IDs of AMIs to aggregate findings for.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
awsEcrContainerAggregation (dict) --

An object that contains details about an aggregation request based on Amazon ECR container images.
- architectures (list) --
  
  The architecture of the containers.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- imageShas (list) --
  
  The image SHA values.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- imageTags (list) --
  
  The image tags.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- inUseCount (list) --
  
  The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
  - (dict) --
    
    An object that describes the details of a number filter.
    - lowerInclusive (float) --
      
      The lowest number to be included in the filter.
    - upperInclusive (float) --
      
      The highest number to be included in the filter.
- lastInUseAt (list) --
  
  The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
  - (dict) --
    
    Contains details on the time range used to filter findings.
    - endInclusive (datetime) --
      
      A timestamp representing the end of the time period filtered on.
    - startInclusive (datetime) --
      
      A timestamp representing the start of the time period filtered on.
- repositories (list) --
  
  The container repositories.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- resourceIds (list) --
  
  The container resource IDs.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort by.
- sortOrder (string) --
  
  The sort order (ascending or descending).
codeRepositoryAggregation (dict) --

An object that contains details about an aggregation request based on code repositories.
- projectNames (list) --
  
  The project names to include in the aggregation results.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- providerTypes (list) --
  
  The repository provider types to include in the aggregation results.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- resourceIds (list) --
  
  The resource IDs to include in the aggregation results.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by in the code repository aggregation.
- sortOrder (string) --
  
  The order to sort results by (ascending or descending) in the code repository aggregation.
ec2InstanceAggregation (dict) --

An object that contains details about an aggregation request based on Amazon EC2 instances.
- amis (list) --
  
  The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- instanceIds (list) --
  
  The Amazon EC2 instance IDs to aggregate findings for.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- instanceTags (list) --
  
  The Amazon EC2 instance tags to aggregate findings for.
  - (dict) --
    
    An object that describes details of a map filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - key (string) -- [REQUIRED]
      
      The tag key used in the filter.
    - value (string) --
      
      The tag value used in the filter.
- operatingSystems (list) --
  
  The operating system types to aggregate findings for. Valid values must be uppercase and underscore separated, examples are ORACLE_LINUX_7 and ALPINE_LINUX_3_8.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
findingTypeAggregation (dict) --

An object that contains details about an aggregation request based on finding types.
- findingType (string) --
  
  The finding type to aggregate.
- resourceType (string) --
  
  The resource type to aggregate.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
imageLayerAggregation (dict) --

An object that contains details about an aggregation request based on container image layers.
- layerHashes (list) --
  
  The hashes associated with the layers.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- repositories (list) --
  
  The repository associated with the container image hosting the layers.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- resourceIds (list) --
  
  The ID of the container image layer.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
lambdaFunctionAggregation (dict) --

Returns an object with findings aggregated by Amazon Web Services Lambda function.
- functionNames (list) --
  
  The Amazon Web Services Lambda function names to include in the aggregation results.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- functionTags (list) --
  
  The tags to include in the aggregation results.
  - (dict) --
    
    An object that describes details of a map filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - key (string) -- [REQUIRED]
      
      The tag key used in the filter.
    - value (string) --
      
      The tag value used in the filter.
- resourceIds (list) --
  
  The resource IDs to include in the aggregation results.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- runtimes (list) --
  
  Returns findings aggregated by Amazon Web Services Lambda function runtime environments.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The finding severity to use for sorting the results.
- sortOrder (string) --
  
  The order to use for sorting the results.
lambdaLayerAggregation (dict) --

Returns an object with findings aggregated by Amazon Web Services Lambda layer.
- functionNames (list) --
  
  The names of the Amazon Web Services Lambda functions associated with the layers.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- layerArns (list) --
  
  The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- resourceIds (list) --
  
  The resource IDs for the Amazon Web Services Lambda function layers.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The finding severity to use for sorting the results.
- sortOrder (string) --
  
  The order to use for sorting the results.
packageAggregation (dict) --

An object that contains details about an aggregation request based on operating system package type.
- packageNames (list) --
  
  The names of packages to aggregate findings on.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
repositoryAggregation (dict) --

An object that contains details about an aggregation request based on Amazon ECR repositories.
- repositories (list) --
  
  The names of repositories to aggregate findings on.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
titleAggregation (dict) --

An object that contains details about an aggregation request based on finding title.
- findingType (string) --
  
  The type of finding to aggregate on.
- resourceType (string) --
  
  The resource type to aggregate on.
- sortBy (string) --
  
  The value to sort results by.
- sortOrder (string) --
  
  The order to sort results by.
- titles (list) --
  
  The finding titles to aggregate on.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
- vulnerabilityIds (list) --
  
  The vulnerability IDs of the findings.
  - (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.

type aggregationType:

string

param aggregationType:

[REQUIRED]

The type of the aggregation request.

type maxResults:

integer

param maxResults:

type nextToken:

string

param nextToken:

rtype:

dict

returns:

Response Syntax

{
    'aggregationType': 'FINDING_TYPE'|'PACKAGE'|'TITLE'|'REPOSITORY'|'AMI'|'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER'|'IMAGE_LAYER'|'ACCOUNT'|'AWS_LAMBDA_FUNCTION'|'LAMBDA_LAYER'|'CODE_REPOSITORY',
    'nextToken': 'string',
    'responses': [
        {
            'accountAggregation': {
                'accountId': 'string',
                'exploitAvailableCount': 123,
                'fixAvailableCount': 123,
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'amiAggregation': {
                'accountId': 'string',
                'affectedInstances': 123,
                'ami': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'awsEcrContainerAggregation': {
                'accountId': 'string',
                'architecture': 'string',
                'imageSha': 'string',
                'imageTags': [
                    'string',
                ],
                'inUseCount': 123,
                'lastInUseAt': datetime(2015, 1, 1),
                'repository': 'string',
                'resourceId': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'codeRepositoryAggregation': {
                'accountId': 'string',
                'exploitAvailableActiveFindingsCount': 123,
                'fixAvailableActiveFindingsCount': 123,
                'projectNames': 'string',
                'providerType': 'string',
                'resourceId': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'ec2InstanceAggregation': {
                'accountId': 'string',
                'ami': 'string',
                'instanceId': 'string',
                'instanceTags': {
                    'string': 'string'
                },
                'networkFindings': 123,
                'operatingSystem': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'findingTypeAggregation': {
                'accountId': 'string',
                'exploitAvailableCount': 123,
                'fixAvailableCount': 123,
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'imageLayerAggregation': {
                'accountId': 'string',
                'layerHash': 'string',
                'repository': 'string',
                'resourceId': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'lambdaFunctionAggregation': {
                'accountId': 'string',
                'functionName': 'string',
                'lambdaTags': {
                    'string': 'string'
                },
                'lastModifiedAt': datetime(2015, 1, 1),
                'resourceId': 'string',
                'runtime': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'lambdaLayerAggregation': {
                'accountId': 'string',
                'functionName': 'string',
                'layerArn': 'string',
                'resourceId': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'packageAggregation': {
                'accountId': 'string',
                'packageName': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'repositoryAggregation': {
                'accountId': 'string',
                'affectedImages': 123,
                'repository': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                }
            },
            'titleAggregation': {
                'accountId': 'string',
                'severityCounts': {
                    'all': 123,
                    'critical': 123,
                    'high': 123,
                    'medium': 123
                },
                'title': 'string',
                'vulnerabilityId': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- aggregationType (string) --
  
  The type of aggregation to perform.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
- responses (list) --
  
  Objects that contain the results of an aggregation operation.
  - (dict) --
    
    A structure that contains details about the results of an aggregation type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: accountAggregation, amiAggregation, awsEcrContainerAggregation, codeRepositoryAggregation, ec2InstanceAggregation, findingTypeAggregation, imageLayerAggregation, lambdaFunctionAggregation, lambdaLayerAggregation, packageAggregation, repositoryAggregation, titleAggregation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - accountAggregation (dict) --
      
      An object that contains details about an aggregation response based on Amazon Web Services account IDs.
      - accountId (string) --
        
        The Amazon Web Services account ID.
      - exploitAvailableCount (integer) --
        
        The number of findings that have an exploit available.
      - fixAvailableCount (integer) --
        
        Details about the number of fixes.
      - severityCounts (dict) --
        
        The number of findings by severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - amiAggregation (dict) --
      
      An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).
      - accountId (string) --
        
        The Amazon Web Services account ID for the AMI.
      - affectedInstances (integer) --
        
        The IDs of Amazon EC2 instances using this AMI.
      - ami (string) --
        
        The ID of the AMI that findings were aggregated for.
      - severityCounts (dict) --
        
        An object that contains the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - awsEcrContainerAggregation (dict) --
      
      An object that contains details about an aggregation response based on Amazon ECR container images.
      - accountId (string) --
        
        The Amazon Web Services account ID of the account that owns the container.
      - architecture (string) --
        
        The architecture of the container.
      - imageSha (string) --
        
        The SHA value of the container image.
      - imageTags (list) --
        
        The container image stags.
        
        (string) --
      - inUseCount (integer) --
        
        The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
      - lastInUseAt (datetime) --
        
        The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
      - repository (string) --
        
        The container repository.
      - resourceId (string) --
        
        The resource ID of the container.
      - severityCounts (dict) --
        
        The number of finding by severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - codeRepositoryAggregation (dict) --
      
      An object that contains details about an aggregation response based on code repositories.
      - accountId (string) --
        
        The Amazon Web Services account ID associated with the code repository.
      - exploitAvailableActiveFindingsCount (integer) --
        
        The number of active findings that have an exploit available for the code repository.
      - fixAvailableActiveFindingsCount (integer) --
        
        The number of active findings that have a fix available for the code repository.
      - projectNames (string) --
        
        The names of the projects associated with the code repository.
      - providerType (string) --
        
        The type of repository provider for the code repository.
      - resourceId (string) --
        
        The resource ID of the code repository.
      - severityCounts (dict) --
        
        An object that contains the counts of aggregated finding per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - ec2InstanceAggregation (dict) --
      
      An object that contains details about an aggregation response based on Amazon EC2 instances.
      - accountId (string) --
        
        The Amazon Web Services account for the Amazon EC2 instance.
      - ami (string) --
        
        The Amazon Machine Image (AMI) of the Amazon EC2 instance.
      - instanceId (string) --
        
        The Amazon EC2 instance ID.
      - instanceTags (dict) --
        
        The tags attached to the instance.
        
        (string) --
        
        (string) --
      - networkFindings (integer) --
        
        The number of network findings for the Amazon EC2 instance.
      - operatingSystem (string) --
        
        The operating system of the Amazon EC2 instance.
      - severityCounts (dict) --
        
        An object that contains the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - findingTypeAggregation (dict) --
      
      An object that contains details about an aggregation response based on finding types.
      - accountId (string) --
        
        The ID of the Amazon Web Services account associated with the findings.
      - exploitAvailableCount (integer) --
        
        The number of findings that have an exploit available.
      - fixAvailableCount (integer) --
        
        Details about the number of fixes.
      - severityCounts (dict) --
        
        The value to sort results by.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - imageLayerAggregation (dict) --
      
      An object that contains details about an aggregation response based on container image layers.
      - accountId (string) --
        
        The ID of the Amazon Web Services account that owns the container image hosting the layer image.
      - layerHash (string) --
        
        The layer hash.
      - repository (string) --
        
        The repository the layer resides in.
      - resourceId (string) --
        
        The resource ID of the container image layer.
      - severityCounts (dict) --
        
        An object that represents the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - lambdaFunctionAggregation (dict) --
      
      An aggregation of findings by Amazon Web Services Lambda function.
      - accountId (string) --
        
        The ID of the Amazon Web Services account that owns the Amazon Web Services Lambda function.
      - functionName (string) --
        
        The Amazon Web Services Lambda function names included in the aggregation results.
      - lambdaTags (dict) --
        
        The tags included in the aggregation results.
        
        (string) --
        
        (string) --
      - lastModifiedAt (datetime) --
        
        The date that the Amazon Web Services Lambda function included in the aggregation results was last changed.
      - resourceId (string) --
        
        The resource IDs included in the aggregation results.
      - runtime (string) --
        
        The runtimes included in the aggregation results.
      - severityCounts (dict) --
        
        An object that contains the counts of aggregated finding per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - lambdaLayerAggregation (dict) --
      
      An aggregation of findings by Amazon Web Services Lambda layer.
      - accountId (string) --
        
        The account ID of the Amazon Web Services Lambda function layer.
      - functionName (string) --
        
        The names of the Amazon Web Services Lambda functions associated with the layers.
      - layerArn (string) --
        
        The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.
      - resourceId (string) --
        
        The Resource ID of the Amazon Web Services Lambda function layer.
      - severityCounts (dict) --
        
        An object that contains the counts of aggregated finding per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - packageAggregation (dict) --
      
      An object that contains details about an aggregation response based on operating system package type.
      - accountId (string) --
        
        The ID of the Amazon Web Services account associated with the findings.
      - packageName (string) --
        
        The name of the operating system package.
      - severityCounts (dict) --
        
        An object that contains the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - repositoryAggregation (dict) --
      
      An object that contains details about an aggregation response based on Amazon ECR repositories.
      - accountId (string) --
        
        The ID of the Amazon Web Services account associated with the findings.
      - affectedImages (integer) --
        
        The number of container images impacted by the findings.
      - repository (string) --
        
        The name of the repository associated with the findings.
      - severityCounts (dict) --
        
        An object that represent the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
    - titleAggregation (dict) --
      
      An object that contains details about an aggregation response based on finding title.
      - accountId (string) --
        
        The ID of the Amazon Web Services account associated with the findings.
      - severityCounts (dict) --
        
        An object that represent the count of matched findings per severity.
        
        all (integer) --
        
        The total count of findings from all severities.
        
        critical (integer) --
        
        The total count of critical severity findings.
        
        high (integer) --
        
        The total count of high severity findings.
        
        medium (integer) --
        
        The total count of medium severity findings.
      - title (string) --
        
        The title that the findings were aggregated on.
      - vulnerabilityId (string) --
        
        The vulnerability ID of the finding.

ListFindings (updated)

Link ¶
Changes (request, response)
Request

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'PREFIX | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'PREFIX | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}]}}

Response

{'findings': {'resources': {'details': {'codeRepository': {'integrationArn': 'string',
                                                           'projectName': 'string',
                                                           'providerType': 'GITHUB '
                                                                           '| '
                                                                           'GITLAB_SELF_MANAGED'}},
                            'type': {'CODE_REPOSITORY'}}}}

Lists findings for your environment.

See also: AWS API Documentation

Request Syntax

client.list_findings(
    filterCriteria={
        'awsAccountId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityFilePath': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceImageId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceSubnetId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceVpcId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageArchitecture': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageHash': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImagePushedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageRegistry': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageRepositoryName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'epssScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'exploitAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatus': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'firstObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'fixAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'inspectorScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'lambdaFunctionExecutionRoleArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionLastModifiedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionLayers': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lastObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'networkProtocol': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'portRange': [
            {
                'beginInclusive': 123,
                'endInclusive': 123
            },
        ],
        'relatedVulnerabilities': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'severity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'title': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'updatedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'vendorSeverity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilityId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilitySource': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerablePackages': [
            {
                'architecture': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'epoch': {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
                'filePath': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'name': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'release': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLambdaLayerArn': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLayerHash': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'version': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                }
            },
        ]
    },
    maxResults=123,
    nextToken='string',
    sortCriteria={
        'field': 'AWS_ACCOUNT_ID'|'FINDING_TYPE'|'SEVERITY'|'FIRST_OBSERVED_AT'|'LAST_OBSERVED_AT'|'FINDING_STATUS'|'RESOURCE_TYPE'|'ECR_IMAGE_PUSHED_AT'|'ECR_IMAGE_REPOSITORY_NAME'|'ECR_IMAGE_REGISTRY'|'NETWORK_PROTOCOL'|'COMPONENT_TYPE'|'VULNERABILITY_ID'|'VULNERABILITY_SOURCE'|'INSPECTOR_SCORE'|'VENDOR_SEVERITY'|'EPSS_SCORE',
        'sortOrder': 'ASC'|'DESC'
    }
)

type filterCriteria:

dict

param filterCriteria:

Details on the filters to apply to your finding results.

awsAccountId (list) --

Details of the Amazon Web Services account IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProjectName (list) --

Filter criteria for findings based on the project name in a code repository.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProviderType (list) --

Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorName (list) --

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorTags (list) --

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityFilePath (list) --

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentId (list) --

Details of the component IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentType (list) --

Details of the component types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceImageId (list) --

Details of the Amazon EC2 instance image IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceSubnetId (list) --

Details of the Amazon EC2 instance subnet IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceVpcId (list) --

Details of the Amazon EC2 instance VPC IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageArchitecture (list) --

Details of the Amazon ECR image architecture types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageHash (list) --

Details of the Amazon ECR image hashes used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageInUseCount (list) --

Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
ecrImageLastInUseAt (list) --

Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImagePushedAt (list) --

Details on the Amazon ECR image push date and time used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImageRegistry (list) --

Details on the Amazon ECR registry used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageRepositoryName (list) --

Details on the name of the Amazon ECR repository used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageTags (list) --

The tags attached to the Amazon ECR container image.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
epssScore (list) --

The EPSS score used to filter findings.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
exploitAvailable (list) --

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingArn (list) --

Details on the finding ARNs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingStatus (list) --

Details on the finding status types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingType (list) --

Details on the finding types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
firstObservedAt (list) --

Details on the date and time a finding was first seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
fixAvailable (list) --

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
inspectorScore (list) --

The Amazon Inspector score to filter on.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
lambdaFunctionExecutionRoleArn (list) --

Filters the list of Amazon Web Services Lambda functions by execution role.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionLastModifiedAt (list) --

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
lambdaFunctionLayers (list) --

Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionName (list) --

Filters the list of Amazon Web Services Lambda functions by the name of the function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionRuntime (list) --

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lastObservedAt (list) --

Details on the date and time a finding was last seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
networkProtocol (list) --

Details on network protocol used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
portRange (list) --

Details on the port ranges used to filter findings.
- (dict) --
  
  An object that describes the details of a port range filter.
  - beginInclusive (integer) --
    
    The port number the port range begins at.
  - endInclusive (integer) --
    
    The port number the port range ends at.
relatedVulnerabilities (list) --

Details on the related vulnerabilities used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceId (list) --

Details on the resource IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceTags (list) --

Details on the resource tags used to filter findings.
- (dict) --
  
  An object that describes details of a map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - key (string) -- [REQUIRED]
    
    The tag key used in the filter.
  - value (string) --
    
    The tag value used in the filter.
resourceType (list) --

Details on the resource types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
severity (list) --

Details on the severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
title (list) --

Details on the finding title used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
updatedAt (list) --

Details on the date and time a finding was last updated at used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
vendorSeverity (list) --

Details on the vendor severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilityId (list) --

Details on the vulnerability ID used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilitySource (list) --

Details on the vulnerability type used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerablePackages (list) --

Details on the vulnerable packages used to filter findings.
- (dict) --
  
  Contains information on the details of a package filter.
  - architecture (dict) --
    
    An object that contains details on the package architecture type to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - epoch (dict) --
    
    An object that contains details on the package epoch to filter on.
    - lowerInclusive (float) --
      
      The lowest number to be included in the filter.
    - upperInclusive (float) --
      
      The highest number to be included in the filter.
  - filePath (dict) --
    
    An object that contains details on the package file path to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - name (dict) --
    
    An object that contains details on the name of the package to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - release (dict) --
    
    An object that contains details on the package release to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLambdaLayerArn (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLayerHash (dict) --
    
    An object that contains details on the source layer hash to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - version (dict) --
    
    The package version to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.

type maxResults:

integer

param maxResults:

type nextToken:

string

param nextToken:

type sortCriteria:

dict

param sortCriteria:

Details on the sort criteria to apply to your finding results.

field (string) -- [REQUIRED]

The finding detail field by which results are sorted.
sortOrder (string) -- [REQUIRED]

The order by which findings are sorted.

rtype:

dict

returns:

Response Syntax

{
    'findings': [
        {
            'awsAccountId': 'string',
            'codeVulnerabilityDetails': {
                'cwes': [
                    'string',
                ],
                'detectorId': 'string',
                'detectorName': 'string',
                'detectorTags': [
                    'string',
                ],
                'filePath': {
                    'endLine': 123,
                    'fileName': 'string',
                    'filePath': 'string',
                    'startLine': 123
                },
                'referenceUrls': [
                    'string',
                ],
                'ruleId': 'string',
                'sourceLambdaLayerArn': 'string'
            },
            'description': 'string',
            'epss': {
                'score': 123.0
            },
            'exploitAvailable': 'YES'|'NO',
            'exploitabilityDetails': {
                'lastKnownExploitAt': datetime(2015, 1, 1)
            },
            'findingArn': 'string',
            'firstObservedAt': datetime(2015, 1, 1),
            'fixAvailable': 'YES'|'NO'|'PARTIAL',
            'inspectorScore': 123.0,
            'inspectorScoreDetails': {
                'adjustedCvss': {
                    'adjustments': [
                        {
                            'metric': 'string',
                            'reason': 'string'
                        },
                    ],
                    'cvssSource': 'string',
                    'score': 123.0,
                    'scoreSource': 'string',
                    'scoringVector': 'string',
                    'version': 'string'
                }
            },
            'lastObservedAt': datetime(2015, 1, 1),
            'networkReachabilityDetails': {
                'networkPath': {
                    'steps': [
                        {
                            'componentArn': 'string',
                            'componentId': 'string',
                            'componentType': 'string'
                        },
                    ]
                },
                'openPortRange': {
                    'begin': 123,
                    'end': 123
                },
                'protocol': 'TCP'|'UDP'
            },
            'packageVulnerabilityDetails': {
                'cvss': [
                    {
                        'baseScore': 123.0,
                        'scoringVector': 'string',
                        'source': 'string',
                        'version': 'string'
                    },
                ],
                'referenceUrls': [
                    'string',
                ],
                'relatedVulnerabilities': [
                    'string',
                ],
                'source': 'string',
                'sourceUrl': 'string',
                'vendorCreatedAt': datetime(2015, 1, 1),
                'vendorSeverity': 'string',
                'vendorUpdatedAt': datetime(2015, 1, 1),
                'vulnerabilityId': 'string',
                'vulnerablePackages': [
                    {
                        'arch': 'string',
                        'epoch': 123,
                        'filePath': 'string',
                        'fixedInVersion': 'string',
                        'name': 'string',
                        'packageManager': 'BUNDLER'|'CARGO'|'COMPOSER'|'NPM'|'NUGET'|'PIPENV'|'POETRY'|'YARN'|'GOBINARY'|'GOMOD'|'JAR'|'OS'|'PIP'|'PYTHONPKG'|'NODEPKG'|'POM'|'GEMSPEC'|'DOTNET_CORE',
                        'release': 'string',
                        'remediation': 'string',
                        'sourceLambdaLayerArn': 'string',
                        'sourceLayerHash': 'string',
                        'version': 'string'
                    },
                ]
            },
            'remediation': {
                'recommendation': {
                    'Url': 'string',
                    'text': 'string'
                }
            },
            'resources': [
                {
                    'details': {
                        'awsEc2Instance': {
                            'iamInstanceProfileArn': 'string',
                            'imageId': 'string',
                            'ipV4Addresses': [
                                'string',
                            ],
                            'ipV6Addresses': [
                                'string',
                            ],
                            'keyName': 'string',
                            'launchedAt': datetime(2015, 1, 1),
                            'platform': 'string',
                            'subnetId': 'string',
                            'type': 'string',
                            'vpcId': 'string'
                        },
                        'awsEcrContainerImage': {
                            'architecture': 'string',
                            'author': 'string',
                            'imageHash': 'string',
                            'imageTags': [
                                'string',
                            ],
                            'inUseCount': 123,
                            'lastInUseAt': datetime(2015, 1, 1),
                            'platform': 'string',
                            'pushedAt': datetime(2015, 1, 1),
                            'registry': 'string',
                            'repositoryName': 'string'
                        },
                        'awsLambdaFunction': {
                            'architectures': [
                                'X86_64'|'ARM64',
                            ],
                            'codeSha256': 'string',
                            'executionRoleArn': 'string',
                            'functionName': 'string',
                            'lastModifiedAt': datetime(2015, 1, 1),
                            'layers': [
                                'string',
                            ],
                            'packageType': 'IMAGE'|'ZIP',
                            'runtime': 'NODEJS'|'NODEJS_12_X'|'NODEJS_14_X'|'NODEJS_16_X'|'JAVA_8'|'JAVA_8_AL2'|'JAVA_11'|'PYTHON_3_7'|'PYTHON_3_8'|'PYTHON_3_9'|'UNSUPPORTED'|'NODEJS_18_X'|'GO_1_X'|'JAVA_17'|'PYTHON_3_10'|'PYTHON_3_11'|'DOTNETCORE_3_1'|'DOTNET_6'|'DOTNET_7'|'RUBY_2_7'|'RUBY_3_2',
                            'version': 'string',
                            'vpcConfig': {
                                'securityGroupIds': [
                                    'string',
                                ],
                                'subnetIds': [
                                    'string',
                                ],
                                'vpcId': 'string'
                            }
                        },
                        'codeRepository': {
                            'integrationArn': 'string',
                            'projectName': 'string',
                            'providerType': 'GITHUB'|'GITLAB_SELF_MANAGED'
                        }
                    },
                    'id': 'string',
                    'partition': 'string',
                    'region': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'type': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'
                },
            ],
            'severity': 'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'|'UNTRIAGED',
            'status': 'ACTIVE'|'SUPPRESSED'|'CLOSED',
            'title': 'string',
            'type': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- findings (list) --
  
  Contains details on the findings in your environment.
  - (dict) --
    
    Details about an Amazon Inspector finding.
    - awsAccountId (string) --
      
      The Amazon Web Services account ID associated with the finding.
    - codeVulnerabilityDetails (dict) --
      
      Details about the code vulnerability identified in a Lambda function used to filter findings.
      - cwes (list) --
        
        The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.
        
        (string) --
      - detectorId (string) --
        
        The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see Amazon CodeGuru Detector Library.
      - detectorName (string) --
        
        The name of the detector used to identify the code vulnerability. For more information on detectors see CodeGuru Detector Library.
      - detectorTags (list) --
        
        The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
        
        (string) --
      - filePath (dict) --
        
        Contains information on where the code vulnerability is located in your code.
        
        endLine (integer) --
        
        The line number of the last line of code that a vulnerability was found in.
        
        fileName (string) --
        
        The name of the file the code vulnerability was found in.
        
        filePath (string) --
        
        The file path to the code that a vulnerability was found in.
        
        startLine (integer) --
        
        The line number of the first line of code that a vulnerability was found in.
      - referenceUrls (list) --
        
        A URL containing supporting documentation about the code vulnerability detected.
        
        (string) --
      - ruleId (string) --
        
        The identifier for a rule that was used to detect the code vulnerability.
      - sourceLambdaLayerArn (string) --
        
        The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.
    - description (string) --
      
      The description of the finding.
    - epss (dict) --
      
      The finding's EPSS score.
      - score (float) --
        
        The EPSS score.
    - exploitAvailable (string) --
      
      If a finding discovered in your environment has an exploit available.
    - exploitabilityDetails (dict) --
      
      The details of an exploit available for a finding discovered in your environment.
      - lastKnownExploitAt (datetime) --
        
        The date and time of the last exploit associated with a finding discovered in your environment.
    - findingArn (string) --
      
      The Amazon Resource Number (ARN) of the finding.
    - firstObservedAt (datetime) --
      
      The date and time that the finding was first observed.
    - fixAvailable (string) --
      
      Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
    - inspectorScore (float) --
      
      The Amazon Inspector score given to the finding.
    - inspectorScoreDetails (dict) --
      
      An object that contains details of the Amazon Inspector score.
      - adjustedCvss (dict) --
        
        An object that contains details about the CVSS score given to a finding.
        
        adjustments (list) --
        
        An object that contains details about adjustment Amazon Inspector made to the CVSS score.
        
        (dict) --
        
        Details on adjustments Amazon Inspector made to the CVSS score for a finding.
        
        metric (string) --
        
        The metric used to adjust the CVSS score.
        
        reason (string) --
        
        The reason the CVSS score has been adjustment.
        
        cvssSource (string) --
        
        The source of the CVSS data.
        
        score (float) --
        
        The CVSS score.
        
        scoreSource (string) --
        
        The source for the CVSS score.
        
        scoringVector (string) --
        
        The vector for the CVSS score.
        
        version (string) --
        
        The CVSS version used in scoring.
    - lastObservedAt (datetime) --
      
      The date and time the finding was last observed. This timestamp for this field remains unchanged until a finding is updated.
    - networkReachabilityDetails (dict) --
      
      An object that contains the details of a network reachability finding.
      - networkPath (dict) --
        
        An object that contains details about a network path associated with a finding.
        
        steps (list) --
        
        The details on the steps in the network path.
        
        (dict) --
        
        Details about the step associated with a finding.
        
        componentArn (string) --
        
        The component ARN. The ARN can be null and is not displayed in the Amazon Web Services console.
        
        componentId (string) --
        
        The component ID.
        
        componentType (string) --
        
        The component type.
      - openPortRange (dict) --
        
        An object that contains details about the open port range associated with a finding.
        
        begin (integer) --
        
        The beginning port in a port range.
        
        end (integer) --
        
        The ending port in a port range.
      - protocol (string) --
        
        The protocol associated with a finding.
    - packageVulnerabilityDetails (dict) --
      
      An object that contains the details of a package vulnerability finding.
      - cvss (list) --
        
        An object that contains details about the CVSS score of a finding.
        
        (dict) --
        
        The CVSS score for a finding.
        
        baseScore (float) --
        
        The base CVSS score used for the finding.
        
        scoringVector (string) --
        
        The vector string of the CVSS score.
        
        source (string) --
        
        The source of the CVSS score.
        
        version (string) --
        
        The version of CVSS used for the score.
      - referenceUrls (list) --
        
        One or more URLs that contain details about this vulnerability type.
        
        (string) --
      - relatedVulnerabilities (list) --
        
        One or more vulnerabilities related to the one identified in this finding.
        
        (string) --
      - source (string) --
        
        The source of the vulnerability information.
      - sourceUrl (string) --
        
        A URL to the source of the vulnerability information.
      - vendorCreatedAt (datetime) --
        
        The date and time that this vulnerability was first added to the vendor's database.
      - vendorSeverity (string) --
        
        The severity the vendor has given to this vulnerability type.
      - vendorUpdatedAt (datetime) --
        
        The date and time the vendor last updated this vulnerability in their database.
      - vulnerabilityId (string) --
        
        The ID given to this vulnerability.
      - vulnerablePackages (list) --
        
        The packages impacted by this vulnerability.
        
        (dict) --
        
        Information on the vulnerable package identified by a finding.
        
        arch (string) --
        
        The architecture of the vulnerable package.
        
        epoch (integer) --
        
        The epoch of the vulnerable package.
        
        filePath (string) --
        
        The file path of the vulnerable package.
        
        fixedInVersion (string) --
        
        The version of the package that contains the vulnerability fix.
        
        name (string) --
        
        The name of the vulnerable package.
        
        packageManager (string) --
        
        The package manager of the vulnerable package.
        
        release (string) --
        
        The release of the vulnerable package.
        
        remediation (string) --
        
        The code to run in your environment to update packages with a fix available.
        
        sourceLambdaLayerArn (string) --
        
        The Amazon Resource Number (ARN) of the Amazon Web Services Lambda function affected by a finding.
        
        sourceLayerHash (string) --
        
        The source layer hash of the vulnerable package.
        
        version (string) --
        
        The version of the vulnerable package.
    - remediation (dict) --
      
      An object that contains the details about how to remediate a finding.
      - recommendation (dict) --
        
        An object that contains information about the recommended course of action to remediate the finding.
        
        Url (string) --
        
        The URL address to the CVE remediation recommendations.
        
        text (string) --
        
        The recommended course of action to remediate the finding.
    - resources (list) --
      
      Contains information on the resources involved in a finding. The resource value determines the valid values for type in your request. For more information, see Finding types in the Amazon Inspector user guide.
      - (dict) --
        
        Details about the resource involved in a finding.
        
        details (dict) --
        
        An object that contains details about the resource involved in a finding.
        
        awsEc2Instance (dict) --
        
        An object that contains details about the Amazon EC2 instance involved in the finding.
        
        iamInstanceProfileArn (string) --
        
        The IAM instance profile ARN of the Amazon EC2 instance.
        
        imageId (string) --
        
        The image ID of the Amazon EC2 instance.
        
        ipV4Addresses (list) --
        
        The IPv4 addresses of the Amazon EC2 instance.
        
        (string) --
        
        ipV6Addresses (list) --
        
        The IPv6 addresses of the Amazon EC2 instance.
        
        (string) --
        
        keyName (string) --
        
        The name of the key pair used to launch the Amazon EC2 instance.
        
        launchedAt (datetime) --
        
        The date and time the Amazon EC2 instance was launched at.
        
        platform (string) --
        
        The platform of the Amazon EC2 instance.
        
        subnetId (string) --
        
        The subnet ID of the Amazon EC2 instance.
        
        type (string) --
        
        The type of the Amazon EC2 instance.
        
        vpcId (string) --
        
        The VPC ID of the Amazon EC2 instance.
        
        awsEcrContainerImage (dict) --
        
        An object that contains details about the Amazon ECR container image involved in the finding.
        
        architecture (string) --
        
        The architecture of the Amazon ECR container image.
        
        author (string) --
        
        The image author of the Amazon ECR container image.
        
        imageHash (string) --
        
        The image hash of the Amazon ECR container image.
        
        imageTags (list) --
        
        The image tags attached to the Amazon ECR container image.
        
        (string) --
        
        inUseCount (integer) --
        
        The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
        
        lastInUseAt (datetime) --
        
        The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
        
        platform (string) --
        
        The platform of the Amazon ECR container image.
        
        pushedAt (datetime) --
        
        The date and time the Amazon ECR container image was pushed.
        
        registry (string) --
        
        The registry for the Amazon ECR container image.
        
        repositoryName (string) --
        
        The name of the repository the Amazon ECR container image resides in.
        
        awsLambdaFunction (dict) --
        
        A summary of the information about an Amazon Web Services Lambda function affected by a finding.
        
        architectures (list) --
        
        The instruction set architecture that the Amazon Web Services Lambda function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.
        
        (string) --
        
        codeSha256 (string) --
        
        The SHA256 hash of the Amazon Web Services Lambda function's deployment package.
        
        executionRoleArn (string) --
        
        The Amazon Web Services Lambda function's execution role.
        
        functionName (string) --
        
        The name of the Amazon Web Services Lambda function.
        
        lastModifiedAt (datetime) --
        
        The date and time that a user last updated the configuration, in ISO 8601 format
        
        layers (list) --
        
        The Amazon Web Services Lambda function's layers. A Lambda function can have up to five layers.
        
        (string) --
        
        packageType (string) --
        
        The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
        
        runtime (string) --
        
        The runtime environment for the Amazon Web Services Lambda function.
        
        version (string) --
        
        The version of the Amazon Web Services Lambda function.
        
        vpcConfig (dict) --
        
        The Amazon Web Services Lambda function's networking configuration.
        
        securityGroupIds (list) --
        
        The VPC security groups and subnets that are attached to an Amazon Web Services Lambda function. For more information, see VPC Settings.
        
        (string) --
        
        subnetIds (list) --
        
        A list of VPC subnet IDs.
        
        (string) --
        
        vpcId (string) --
        
        The ID of the VPC.
        
        codeRepository (dict) --
        
        Contains details about a code repository resource associated with a finding.
        
        integrationArn (string) --
        
        The Amazon Resource Name (ARN) of the code security integration associated with the repository.
        
        projectName (string) --
        
        The name of the project in the code repository.
        
        providerType (string) --
        
        The type of repository provider (such as GitHub, GitLab, etc.).
        
        id (string) --
        
        The ID of the resource.
        
        partition (string) --
        
        The partition of the resource.
        
        region (string) --
        
        The Amazon Web Services Region the impacted resource is located in.
        
        tags (dict) --
        
        The tags attached to the resource.
        
        (string) --
        
        (string) --
        
        type (string) --
        
        The type of resource.
    - severity (string) --
      
      The severity of the finding. UNTRIAGED applies to PACKAGE_VULNERABILITY type findings that the vendor has not assigned a severity yet. For more information, see Severity levels for findings in the Amazon Inspector user guide.
    - status (string) --
      
      The status of the finding.
    - title (string) --
      
      The title of the finding.
    - type (string) --
      
      The type of the finding. The type value determines the valid values for resource in your request. For more information, see Finding types in the Amazon Inspector user guide.
    - updatedAt (datetime) --
      
      The date and time the finding was last updated at.
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

ListUsageTotals (updated)

Link ¶
Changes (response)

{'totals': {'usage': {'type': {'CODE_REPOSITORY_IAC',
                               'CODE_REPOSITORY_SAST',
                               'CODE_REPOSITORY_SCA'}}}}

Lists the Amazon Inspector usage totals over the last 30 days.

See also: AWS API Documentation

Request Syntax

client.list_usage_totals(
    accountIds=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

type accountIds:

list

param accountIds:

The Amazon Web Services account IDs to retrieve usage totals for.

(string) --

type maxResults:

integer

param maxResults:

type nextToken:

string

param nextToken:

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'totals': [
        {
            'accountId': 'string',
            'usage': [
                {
                    'currency': 'USD',
                    'estimatedMonthlyCost': 123.0,
                    'total': 123.0,
                    'type': 'EC2_INSTANCE_HOURS'|'ECR_INITIAL_SCAN'|'ECR_RESCAN'|'LAMBDA_FUNCTION_HOURS'|'LAMBDA_FUNCTION_CODE_HOURS'|'CODE_REPOSITORY_SAST'|'CODE_REPOSITORY_IAC'|'CODE_REPOSITORY_SCA'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination parameter to be used on the next list operation to retrieve more items.
- totals (list) --
  
  An object with details on the total usage for the requested account.
  - (dict) --
    
    The total of usage for an account ID.
    - accountId (string) --
      
      The account ID of the account that usage data was retrieved for.
    - usage (list) --
      
      An object representing the total usage for an account.
      - (dict) --
        
        Contains usage information about the cost of Amazon Inspector operation.
        
        currency (string) --
        
        The currency type used when calculating usage data.
        
        estimatedMonthlyCost (float) --
        
        The estimated monthly cost of Amazon Inspector.
        
        total (float) --
        
        The total of usage.
        
        type (string) --
        
        The type scan.

ResetEncryptionKey (updated)

Link ¶
Changes (request)

{'resourceType': {'CODE_REPOSITORY'}}

Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.

See also: AWS API Documentation

Request Syntax

client.reset_encryption_key(
    resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY',
    scanType='NETWORK'|'PACKAGE'|'CODE'
)

type resourceType:

string

param resourceType:

[REQUIRED]

The resource type the key encrypts.

type scanType:

string

param scanType:

[REQUIRED]

The scan type the key encrypts.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateEncryptionKey (updated)

Link ¶
Changes (request)

{'resourceType': {'CODE_REPOSITORY'}}

Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

See also: AWS API Documentation

Request Syntax

client.update_encryption_key(
    kmsKeyId='string',
    resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY',
    scanType='NETWORK'|'PACKAGE'|'CODE'
)

type kmsKeyId:

string

param kmsKeyId:

[REQUIRED]

A KMS key ID for the encryption key.

type resourceType:

string

param resourceType:

[REQUIRED]

The resource type for the encryption key.

type scanType:

string

param scanType:

[REQUIRED]

The scan type for the encryption key.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateFilter (updated)

Link ¶
Changes (request)

{'filterCriteria': {'codeRepositoryProjectName': [{'comparison': 'EQUALS | '
                                                                 'PREFIX | '
                                                                 'NOT_EQUALS',
                                                   'value': 'string'}],
                    'codeRepositoryProviderType': [{'comparison': 'EQUALS | '
                                                                  'PREFIX | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}]}}

Specifies the action that is to be applied to the findings that match the filter.

See also: AWS API Documentation

Request Syntax

client.update_filter(
    action='NONE'|'SUPPRESS',
    description='string',
    filterArn='string',
    filterCriteria={
        'awsAccountId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProjectName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeRepositoryProviderType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityDetectorTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'codeVulnerabilityFilePath': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'componentType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceImageId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceSubnetId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceVpcId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageArchitecture': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageHash': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageInUseCount': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'ecrImageLastInUseAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImagePushedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'ecrImageRegistry': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageRepositoryName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'epssScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'exploitAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatus': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'firstObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'fixAvailable': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'inspectorScore': [
            {
                'lowerInclusive': 123.0,
                'upperInclusive': 123.0
            },
        ],
        'lambdaFunctionExecutionRoleArn': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionLastModifiedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionLayers': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lastObservedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'networkProtocol': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'portRange': [
            {
                'beginInclusive': 123,
                'endInclusive': 123
            },
        ],
        'relatedVulnerabilities': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'severity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'title': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'updatedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'vendorSeverity': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilityId': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerabilitySource': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'vulnerablePackages': [
            {
                'architecture': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'epoch': {
                    'lowerInclusive': 123.0,
                    'upperInclusive': 123.0
                },
                'filePath': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'name': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'release': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLambdaLayerArn': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'sourceLayerHash': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                },
                'version': {
                    'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                    'value': 'string'
                }
            },
        ]
    },
    name='string',
    reason='string'
)

type action:

string

param action:

Specifies the action that is to be applied to the findings that match the filter.

type description:

string

param description:

A description of the filter.

type filterArn:

string

param filterArn:

[REQUIRED]

The Amazon Resource Number (ARN) of the filter to update.

type filterCriteria:

dict

param filterCriteria:

Defines the criteria to be update in the filter.

awsAccountId (list) --

Details of the Amazon Web Services account IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProjectName (list) --

Filter criteria for findings based on the project name in a code repository.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeRepositoryProviderType (list) --

Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.).
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorName (list) --

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityDetectorTags (list) --

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
codeVulnerabilityFilePath (list) --

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentId (list) --

Details of the component IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
componentType (list) --

Details of the component types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceImageId (list) --

Details of the Amazon EC2 instance image IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceSubnetId (list) --

Details of the Amazon EC2 instance subnet IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ec2InstanceVpcId (list) --

Details of the Amazon EC2 instance VPC IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageArchitecture (list) --

Details of the Amazon ECR image architecture types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageHash (list) --

Details of the Amazon ECR image hashes used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageInUseCount (list) --

Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
ecrImageLastInUseAt (list) --

Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImagePushedAt (list) --

Details on the Amazon ECR image push date and time used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
ecrImageRegistry (list) --

Details on the Amazon ECR registry used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageRepositoryName (list) --

Details on the name of the Amazon ECR repository used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
ecrImageTags (list) --

The tags attached to the Amazon ECR container image.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
epssScore (list) --

The EPSS score used to filter findings.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
exploitAvailable (list) --

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingArn (list) --

Details on the finding ARNs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingStatus (list) --

Details on the finding status types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
findingType (list) --

Details on the finding types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
firstObservedAt (list) --

Details on the date and time a finding was first seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
fixAvailable (list) --

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
inspectorScore (list) --

The Amazon Inspector score to filter on.
- (dict) --
  
  An object that describes the details of a number filter.
  - lowerInclusive (float) --
    
    The lowest number to be included in the filter.
  - upperInclusive (float) --
    
    The highest number to be included in the filter.
lambdaFunctionExecutionRoleArn (list) --

Filters the list of Amazon Web Services Lambda functions by execution role.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionLastModifiedAt (list) --

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
lambdaFunctionLayers (list) --

Filters the list of Amazon Web Services Lambda functions by the function's layers. A Lambda function can have up to five layers.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionName (list) --

Filters the list of Amazon Web Services Lambda functions by the name of the function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lambdaFunctionRuntime (list) --

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
lastObservedAt (list) --

Details on the date and time a finding was last seen used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
networkProtocol (list) --

Details on network protocol used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
portRange (list) --

Details on the port ranges used to filter findings.
- (dict) --
  
  An object that describes the details of a port range filter.
  - beginInclusive (integer) --
    
    The port number the port range begins at.
  - endInclusive (integer) --
    
    The port number the port range ends at.
relatedVulnerabilities (list) --

Details on the related vulnerabilities used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceId (list) --

Details on the resource IDs used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
resourceTags (list) --

Details on the resource tags used to filter findings.
- (dict) --
  
  An object that describes details of a map filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - key (string) -- [REQUIRED]
    
    The tag key used in the filter.
  - value (string) --
    
    The tag value used in the filter.
resourceType (list) --

Details on the resource types used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
severity (list) --

Details on the severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
title (list) --

Details on the finding title used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
updatedAt (list) --

Details on the date and time a finding was last updated at used to filter findings.
- (dict) --
  
  Contains details on the time range used to filter findings.
  - endInclusive (datetime) --
    
    A timestamp representing the end of the time period filtered on.
  - startInclusive (datetime) --
    
    A timestamp representing the start of the time period filtered on.
vendorSeverity (list) --

Details on the vendor severity used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilityId (list) --

Details on the vulnerability ID used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerabilitySource (list) --

Details on the vulnerability type used to filter findings.
- (dict) --
  
  An object that describes the details of a string filter.
  - comparison (string) -- [REQUIRED]
    
    The operator to use when comparing values in the filter.
  - value (string) -- [REQUIRED]
    
    The value to filter on.
vulnerablePackages (list) --

Details on the vulnerable packages used to filter findings.
- (dict) --
  
  Contains information on the details of a package filter.
  - architecture (dict) --
    
    An object that contains details on the package architecture type to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - epoch (dict) --
    
    An object that contains details on the package epoch to filter on.
    - lowerInclusive (float) --
      
      The lowest number to be included in the filter.
    - upperInclusive (float) --
      
      The highest number to be included in the filter.
  - filePath (dict) --
    
    An object that contains details on the package file path to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - name (dict) --
    
    An object that contains details on the name of the package to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - release (dict) --
    
    An object that contains details on the package release to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLambdaLayerArn (dict) --
    
    An object that describes the details of a string filter.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - sourceLayerHash (dict) --
    
    An object that contains details on the source layer hash to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.
  - version (dict) --
    
    The package version to filter on.
    - comparison (string) -- [REQUIRED]
      
      The operator to use when comparing values in the filter.
    - value (string) -- [REQUIRED]
      
      The value to filter on.

type name:

string

param name:

The name of the filter.

type reason:

string

param reason:

The reason the filter was updated.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Number (ARN) of the successfully updated filter.

UpdateOrganizationConfiguration (updated)

Link ¶
Changes (both)

{'autoEnable': {'codeRepository': 'boolean'}}

Updates the configurations for your Amazon Inspector organization.

See also: AWS API Documentation

Request Syntax

client.update_organization_configuration(
    autoEnable={
        'codeRepository': True|False,
        'ec2': True|False,
        'ecr': True|False,
        'lambda': True|False,
        'lambdaCode': True|False
    }
)

type autoEnable:

dict

param autoEnable:

[REQUIRED]

Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

codeRepository (boolean) --

Represents whether code repository scans are automatically enabled for new members of your Amazon Inspector organization.
ec2 (boolean) -- [REQUIRED]

Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.
ecr (boolean) -- [REQUIRED]

Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.
lambda (boolean) --

Represents whether Amazon Web Services Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.
lambdaCode (boolean) --

Represents whether Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.

rtype:

dict

returns:

Response Syntax

{
    'autoEnable': {
        'codeRepository': True|False,
        'ec2': True|False,
        'ecr': True|False,
        'lambda': True|False,
        'lambdaCode': True|False
    }
}

Response Structure

(dict) --
- autoEnable (dict) --
  
  The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.
  - codeRepository (boolean) --
    
    Represents whether code repository scans are automatically enabled for new members of your Amazon Inspector organization.
  - ec2 (boolean) --
    
    Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.
  - ecr (boolean) --
    
    Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.
  - lambda (boolean) --
    
    Represents whether Amazon Web Services Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.
  - lambdaCode (boolean) --
    
    Represents whether Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.