2026/07/07 - Inspector2 - 6 new 16 updated api methods
Changes This release extends vulnerability management to Azure VM, container registries and function apps. Adds support for per-member-account scan configuration settings.
Updates the description or provider-specific configuration details of an existing connector.
See also: AWS API Documentation
Request Syntax
client.update_connector(
connectorArn='string',
description='string',
providerDetail={
'azure': {
'azureRegions': [
'string',
],
'scopeConfiguration': {
'vmScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
},
'containerImageScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
},
'serverlessScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
}
},
'autoInstallVMScanner': True|False
}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the connector to update.
string
The updated description of the connector.
dict
The updated provider-specific configuration details for the connector.
azure (dict) --
The Azure-specific details for updating a connector.
azureRegions (list) --
The updated Azure regions to scan.
(string) --
scopeConfiguration (dict) --
The updated scope configuration that defines which Azure resources to scan.
vmScanning (dict) --
The scope configuration input for VM scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
containerImageScanning (dict) --
The scope configuration input for container image scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
serverlessScanning (dict) --
The scope configuration input for serverless scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
autoInstallVMScanner (boolean) --
Specifies whether to automatically install the VM scanner on connected Azure resources.
dict
Response Syntax
{
'connectorArn': 'string'
}
Response Structure
(dict) --
connectorArn (string) --
The Amazon Resource Name (ARN) of the updated connector.
Updates scan configuration settings for resources associated with an Amazon Web Services Config connector.
See also: AWS API Documentation
Request Syntax
client.update_connector_scan_configuration(
awsConfigConnectorArn='string',
scanConfiguration={
'containerImageScanning': {
'pushDuration': 'LIFETIME'|'DAYS_3'|'DAYS_7'|'DAYS_30'|'DAYS_180'|'DAYS_14'|'DAYS_60'|'DAYS_90',
'pullDuration': 'DAYS_3'|'DAYS_7'|'DAYS_14'|'DAYS_30'|'DAYS_60'|'DAYS_90'|'DAYS_180'
}
}
)
string
[REQUIRED]
The ARN of the Amazon Web Services Config connector.
dict
[REQUIRED]
The scan configuration settings to apply.
containerImageScanning (dict) --
The container image scanning configuration, including push and pull duration settings.
pushDuration (string) --
The amount of time after a container image is pushed to a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are LIFETIME, DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180.
pullDuration (string) --
The amount of time after a container image is last pulled from a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.
See also: AWS API Documentation
Request Syntax
client.create_connector(
clientToken='string',
name='string',
provider='AZURE',
description='string',
providerDetail={
'azure': {
'awsConfigConnectorArn': 'string',
'scopeConfiguration': {
'vmScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
},
'containerImageScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
},
'serverlessScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
]
}
},
'azureRegions': [
'string',
],
'autoInstallVMScanner': True|False
}
},
tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the connector.
string
[REQUIRED]
The cloud provider for the connector.
string
A description of the connector.
dict
[REQUIRED]
The provider-specific configuration details for the connector.
azure (dict) --
The Azure-specific details for creating a connector.
awsConfigConnectorArn (string) -- [REQUIRED]
The ARN of the Amazon Web Services Config connector to associate with this connector.
scopeConfiguration (dict) -- [REQUIRED]
The scope configuration that defines which Azure resources to scan.
vmScanning (dict) --
The scope configuration input for VM scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
containerImageScanning (dict) --
The scope configuration input for container image scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
serverlessScanning (dict) --
The scope configuration input for serverless scanning.
scopeType (string) -- [REQUIRED]
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
azureRegions (list) -- [REQUIRED]
The Azure regions to scan.
(string) --
autoInstallVMScanner (boolean) --
Specifies whether to automatically install the VM scanner on connected Azure resources. Defaults to true.
dict
The tags to apply to the connector.
(string) --
(string) --
dict
Response Syntax
{
'connectorArn': 'string'
}
Response Structure
(dict) --
connectorArn (string) --
The Amazon Resource Name (ARN) of the created connector.
Lists connectors in your account. Results are paginated. Use the nextToken parameter to retrieve the next page of results.
See also: AWS API Documentation
Request Syntax
client.list_connectors(
maxResults=123,
nextToken='string',
filterCriteria={
'connectorArns': [
{
'comparison': 'EQUALS',
'value': 'string'
},
],
'accounts': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsConfigConnectorArns': [
{
'comparison': 'EQUALS',
'value': 'string'
},
],
'connectorType': [
{
'comparison': 'EQUALS',
'value': 'CUSTOMER_MANAGED'|'SERVICE_LINKED'
},
],
'provider': [
{
'comparison': 'EQUALS',
'value': 'AZURE'
},
]
}
)
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the nextToken value returned from this request.
string
A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
dict
The filter criteria to apply to the list of connectors.
connectorArns (list) --
Filter by connector ARNs.
(dict) --
A filter that matches connectors by connector ARN.
comparison (string) -- [REQUIRED]
The comparison operator for the connector ARN filter.
value (string) -- [REQUIRED]
The connector ARN value to filter by.
accounts (list) --
Filter by Amazon Web Services account 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.
awsConfigConnectorArns (list) --
Filter by Amazon Web Services Config connector ARNs.
(dict) --
A filter that matches connectors by the ARN of the associated Amazon Web Services Config connector.
comparison (string) -- [REQUIRED]
The comparison operator for the Amazon Web Services Config connector ARN filter.
value (string) -- [REQUIRED]
The Amazon Web Services Config connector ARN value to filter by.
connectorType (list) --
Filter by connector type.
(dict) --
A filter that matches connectors by connector type.
comparison (string) -- [REQUIRED]
The comparison operator for the connector type filter.
value (string) -- [REQUIRED]
The connector type value to filter by.
provider (list) --
Filter by cloud provider.
(dict) --
A filter that matches connectors by cloud provider.
comparison (string) -- [REQUIRED]
The comparison operator for the provider filter.
value (string) -- [REQUIRED]
The cloud provider value to filter by.
dict
Response Syntax
{
'items': [
{
'connectorArn': 'string',
'name': 'string',
'description': 'string',
'provider': 'AZURE',
'enablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'DELETED'|'FAILED_TO_DELETE',
'enablementStatusReason': 'string',
'health': {
'connectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
'lastCheckedAt': datetime(2015, 1, 1),
'message': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'azureRegions': [
'string',
],
'awsConfigConnectorArn': 'string',
'scopeConfiguration': {
'vmScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
],
'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
'stateReason': 'string'
},
'containerImageScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
],
'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
'stateReason': 'string'
},
'serverlessScanning': {
'scopeType': 'TENANT'|'SUBSCRIPTION',
'scopeValues': [
'string',
],
'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
'stateReason': 'string'
}
},
'tags': {
'string': 'string'
},
'autoInstallVMScanner': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of connectors.
(dict) --
Describes a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.
connectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
name (string) --
The name of the connector.
description (string) --
A description of the connector.
provider (string) --
The cloud provider for the connector.
enablementStatus (string) --
The enablement status of the connector, which indicates whether the connector is active and scanning resources.
enablementStatusReason (string) --
Additional information about the current enablement status of the connector.
health (dict) --
The health of the connector, which indicates whether Amazon Inspector can reach and scan the connected resources.
connectorStatus (string) --
The health status of the connector.
lastCheckedAt (datetime) --
The date and time when the connector health was last checked.
message (string) --
A message providing additional details about the connector health status.
createdAt (datetime) --
The date and time when the connector was created.
updatedAt (datetime) --
The date and time when the connector was last updated.
azureRegions (list) --
The Azure regions configured for the connector.
(string) --
awsConfigConnectorArn (string) --
The ARN of the Amazon Web Services Config connector associated with this connector.
scopeConfiguration (dict) --
The Azure scope configuration for the connector.
vmScanning (dict) --
The scope configuration for VM scanning.
scopeType (string) --
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
state (string) --
The current state of the scope configuration.
stateReason (string) --
The reason for the current state of the scope configuration.
containerImageScanning (dict) --
The scope configuration for container image scanning.
scopeType (string) --
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
state (string) --
The current state of the scope configuration.
stateReason (string) --
The reason for the current state of the scope configuration.
serverlessScanning (dict) --
The scope configuration for serverless scanning.
scopeType (string) --
The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
scopeValues (list) --
The list of scope values. For subscription-level scope, these are Azure subscription IDs.
(string) --
state (string) --
The current state of the scope configuration.
stateReason (string) --
The reason for the current state of the scope configuration.
tags (dict) --
The tags associated with the connector.
(string) --
(string) --
autoInstallVMScanner (boolean) --
Specifies whether the VM scanner is automatically installed on connected resources.
nextToken (string) --
A pagination token. If this value is not null, there are additional results available. Use this token in the nextToken parameter of a subsequent request to retrieve the next page of results.
Lists scan configurations for Amazon Web Services Config connectors. Results are paginated. Use the nextToken parameter to retrieve the next page of results.
See also: AWS API Documentation
Request Syntax
client.list_connector_scan_configurations(
awsConfigConnectorArns=[
'string',
],
maxResults=123,
nextToken='string'
)
list
The list of Amazon Web Services Config connector ARNs to filter results.
(string) --
integer
The maximum number of results to return in a single call. Valid range is 1 to 50. To retrieve the remaining results, make another request with the nextToken value returned from this request.
string
A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
dict
Response Syntax
{
'scanConfigurations': [
{
'awsConfigConnectorArn': 'string',
'connectorArns': [
'string',
],
'scanConfiguration': {
'containerImageScanning': {
'pushDuration': 'LIFETIME'|'DAYS_3'|'DAYS_7'|'DAYS_30'|'DAYS_180'|'DAYS_14'|'DAYS_60'|'DAYS_90',
'pullDuration': 'DAYS_3'|'DAYS_7'|'DAYS_14'|'DAYS_30'|'DAYS_60'|'DAYS_90'|'DAYS_180'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
scanConfigurations (list) --
A list of scan configuration items.
(dict) --
Represents a scan configuration and the connectors it applies to. Returned in the results of a ListConnectorScanConfigurations request.
awsConfigConnectorArn (string) --
The ARN of the Amazon Web Services Config connector.
connectorArns (list) --
The list of connector ARNs associated with this Amazon Web Services Config connector.
(string) --
scanConfiguration (dict) --
The scan configuration settings.
containerImageScanning (dict) --
The container image scanning configuration, including push and pull duration settings.
pushDuration (string) --
The amount of time after a container image is pushed to a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are LIFETIME, DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180.
pullDuration (string) --
The amount of time after a container image is last pulled from a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180.
nextToken (string) --
A pagination token. If this value is not null, there are additional results available. Use this token in the nextToken parameter of a subsequent request to retrieve the next page of results.
Deletes a connector from your account.
See also: AWS API Documentation
Request Syntax
client.delete_connector(
connectorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the connector to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accounts': {'freeTrialInfo': {'cloudProvider': 'AWS | AZURE | NOT_APPLICABLE',
'type': {'CONTAINER_IMAGE',
'SERVERLESS_FUNCTION',
'VM'}}}}
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',
]
)
list
[REQUIRED]
The account IDs to get free trial status for.
(string) --
dict
Response Syntax
{
'accounts': [
{
'accountId': 'string',
'freeTrialInfo': [
{
'type': 'EC2'|'ECR'|'LAMBDA'|'LAMBDA_CODE'|'CODE_REPOSITORY'|'VM'|'CONTAINER_IMAGE'|'SERVERLESS_FUNCTION',
'start': datetime(2015, 1, 1),
'end': datetime(2015, 1, 1),
'status': 'ACTIVE'|'INACTIVE',
'cloudProvider': 'AWS'|'AZURE'|'NOT_APPLICABLE'
},
]
},
],
'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.
type (string) --
The type of scan covered by the Amazon Inspector free trail.
start (datetime) --
The date and time that the Amazon Inspector free trail started for a given account.
end (datetime) --
The date and time that the Amazon Inspector free trail ends for a given account.
status (string) --
The order to sort results by.
cloudProvider (string) --
The cloud provider associated with the free trial information.
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.
{'filterCriteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'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={
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
},
name='string',
tags={
'string': 'string'
},
reason='string'
)
string
[REQUIRED]
Defines the action that is to be applied to the findings that match the filter.
string
A description of the filter.
dict
[REQUIRED]
Defines the criteria to be used in the filter for querying findings.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
string
[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.
dict
A list of tags for the filter.
(string) --
(string) --
string
The reason for creating the filter.
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Number (ARN) of the successfully created filter.
{'filterCriteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'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={
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
},
reportFormat='CSV'|'JSON',
s3Destination={
'bucketName': 'string',
'keyPrefix': 'string',
'kmsKeyArn': 'string'
}
)
dict
The filter criteria to apply to the results of the finding report.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
string
[REQUIRED]
The format to generate the report in.
dict
[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.
dict
Response Syntax
{
'reportId': 'string'
}
Response Structure
(dict) --
reportId (string) --
The ID of the report.
{'accountId': 'string'}
Retrieves setting configurations for Amazon Inspector scans. If you specify an accountId, this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an accountId, this operation returns your own scan configuration.
See also: AWS API Documentation
Request Syntax
client.get_configuration(
accountId='string'
)
string
The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to retrieve. When specified, you must be the delegated administrator for this member account. If not specified, the operation returns your own configuration.
dict
Response Syntax
{
'ecrConfiguration': {
'rescanDurationState': {
'rescanDuration': 'LIFETIME'|'DAYS_30'|'DAYS_180'|'DAYS_14'|'DAYS_60'|'DAYS_90',
'status': 'SUCCESS'|'PENDING'|'FAILED',
'updatedAt': datetime(2015, 1, 1),
'pullDateRescanDuration': 'DAYS_14'|'DAYS_30'|'DAYS_60'|'DAYS_90'|'DAYS_180',
'pullDateRescanMode': 'LAST_PULL_DATE'|'LAST_IN_USE_AT'
}
},
'ec2Configuration': {
'scanModeState': {
'scanMode': 'EC2_SSM_AGENT_BASED'|'EC2_HYBRID',
'scanModeStatus': 'SUCCESS'|'PENDING'
},
'vmScannerState': {
'activated': True|False,
'activatedAt': datetime(2015, 1, 1),
'status': 'SUCCESS'|'PENDING'|'FAILED'
}
}
}
Response Structure
(dict) --
ecrConfiguration (dict) --
Specifies how the ECR automated re-scan duration is currently configured for your environment.
rescanDurationState (dict) --
An object that contains details about the state of the ECR re-scan settings.
rescanDuration (string) --
The rescan duration configured for image push date.
status (string) --
The status of changes to the ECR automated re-scan duration.
updatedAt (datetime) --
A timestamp representing when the last time the ECR scan duration setting was changed.
pullDateRescanDuration (string) --
The rescan duration configured for image pull date.
pullDateRescanMode (string) --
The pull date for the re-scan mode.
ec2Configuration (dict) --
Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.
scanModeState (dict) --
An object that contains details about the state of the Amazon EC2 scan mode.
scanMode (string) --
The scan method that is applied to the instance.
scanModeStatus (string) --
The status of the Amazon EC2 scan mode setting.
vmScannerState (dict) --
An object that contains details about the state of the Amazon Inspector VM scanner.
activated (boolean) --
Whether the VM scanner is activated.
activatedAt (datetime) --
The date and time the VM scanner was activated.
status (string) --
The status of the VM scanner.
{'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}}
Gets an encryption key.
See also: AWS API Documentation
Request Syntax
client.get_encryption_key(
scanType='NETWORK'|'PACKAGE'|'CODE',
resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites'
)
string
[REQUIRED]
The scan type the key encrypts.
string
[REQUIRED]
The resource type the key encrypts.
dict
Response Syntax
{
'kmsKeyId': 'string'
}
Response Structure
(dict) --
kmsKeyId (string) --
A kms key ID.
{'filterCriteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'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'
)
string
The ID of the report to retrieve the status of.
dict
Response Syntax
{
'reportId': 'string',
'status': 'SUCCEEDED'|'IN_PROGRESS'|'CANCELLED'|'FAILED',
'errorCode': 'INTERNAL_ERROR'|'INVALID_PERMISSIONS'|'NO_FINDINGS_FOUND'|'BUCKET_NOT_FOUND'|'INCOMPATIBLE_BUCKET_REGION'|'MALFORMED_KMS_KEY',
'errorMessage': 'string',
'destination': {
'bucketName': 'string',
'keyPrefix': 'string',
'kmsKeyArn': 'string'
},
'filterCriteria': {
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
reportId (string) --
The ID of the report.
status (string) --
The status of the report.
errorCode (string) --
The error code of the report.
errorMessage (string) --
The error message of the report.
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.
filterCriteria (dict) --
The filter criteria associated with the report.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
{'filterCriteria': {'cloudContainerImageTags': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudContainerRegistryName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudContainerRepositoryName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionTags': [{'comparison': 'EQUALS',
'key': 'string',
'value': 'string'}],
'cloudVmInstanceTags': [{'comparison': 'EQUALS',
'key': 'string',
'value': 'string'}]}}
Response {'coveredResources': {'provider': 'AWS | AZURE',
'providerAccountId': 'string',
'providerOrgId': 'string',
'providerPartition': 'string',
'providerRegion': 'string',
'resourceMetadata': {'codeRepository': {'onDemandScan': {'scanStatus': {'reason': {'RESOURCE_STOPPED',
'RESOURCE_UNMANAGED'}}}},
'containerImage': {'imagePulledAt': 'timestamp',
'imageTags': ['string'],
'inUseCount': 'long',
'lastInUseAt': 'timestamp'},
'containerRegistry': {'name': 'string'},
'containerRepository': {'name': 'string',
'scanFrequency': 'string'},
'lambdaFunction': {'runtime': {'JAVA_21',
'JAVA_25',
'NODEJS_22_X'}},
'serverlessFunction': {'functionTags': {'string': 'string'},
'runtime': 'string',
'serverlessFunctionName': 'string'},
'vmInstance': {'inventoryHash': 'string',
'platform': 'WINDOWS '
'| LINUX '
'| '
'UNKNOWN',
'tags': {'string': 'string'},
'vmImageReference': 'string'}},
'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registries',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.ContainerRegistry/registry/containerRepository',
'Microsoft.Web/sites'},
'scanMode': {'VM_INSPECTOR_AGENT_BASED'},
'scanStatus': {'reason': {'RESOURCE_STOPPED',
'RESOURCE_UNMANAGED'}}}}
Lists coverage details for your environment.
See also: AWS API Documentation
Request Syntax
client.list_coverage(
maxResults=123,
nextToken='string',
filterCriteria={
'scanStatusCode': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'scanStatusReason': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'accountId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'scanType': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrRepositoryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'lastScannedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'scanMode': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'imagePulledAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123,
'lowerInclusive': 123
},
],
'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'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmInstanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'cloudContainerImageTags': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudContainerRepositoryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudContainerRegistryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
]
}
)
integer
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.
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. 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.
dict
An object that contains details on the filters to apply to the coverage data for your environment.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
scanMode (list) --
The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED, EC2_AGENTLESS, and EC2_INSPECTOR_AGENT_BASED.
(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.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
ecrImageLastInUseAt (list) --
The Amazon ECR image that was last in use.
(dict) --
Contains details of a coverage date filter.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
ecrImageInUseCount (list) --
The number of Amazon ECR images in use.
(dict) --
The coverage number to be used in the filter.
upperInclusive (integer) --
The upper inclusive for the coverage number.>
lowerInclusive (integer) --
The lower inclusive for the coverage number.
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.
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.
cloudProvider (list) --
The cloud provider to filter coverage results by.
(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.
cloudProviderAccountId (list) --
The cloud provider account ID to filter coverage results by.
(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.
cloudProviderRegion (list) --
The cloud provider region to filter coverage results by.
(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.
cloudVmInstanceTags (list) --
The cloud VM instance tags to filter coverage results by.
(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.
cloudContainerImageTags (list) --
The cloud container image tags to filter coverage results by.
(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.
cloudContainerRepositoryName (list) --
The cloud container repository name to filter coverage results by.
(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.
cloudContainerRegistryName (list) --
The cloud container registry name to filter coverage results by.
(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.
cloudServerlessFunctionName (list) --
The cloud serverless function name to filter coverage results by.
(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.
cloudServerlessFunctionRuntime (list) --
The cloud serverless function runtime to filter coverage results by.
(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.
cloudServerlessFunctionTags (list) --
The cloud serverless function tags to filter coverage results by.
(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.
cloudProviderOrgId (list) --
The cloud provider organization ID to filter coverage results by.
(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.
dict
Response Syntax
{
'nextToken': 'string',
'coveredResources': [
{
'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.ContainerRegistry/registry/containerRepository'|'Microsoft.Web/sites'|'Microsoft.ContainerRegistry/registries',
'resourceId': 'string',
'accountId': 'string',
'scanType': 'NETWORK'|'PACKAGE'|'CODE',
'scanStatus': {
'statusCode': 'ACTIVE'|'INACTIVE',
'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'|'IMAGE_ARCHIVED'|'UNSUPPORTED_CODE_ARTIFACTS'|'RESOURCE_UNMANAGED'|'RESOURCE_STOPPED'
},
'resourceMetadata': {
'ecrRepository': {
'name': 'string',
'scanFrequency': 'MANUAL'|'SCAN_ON_PUSH'|'CONTINUOUS_SCAN'
},
'ecrImage': {
'tags': [
'string',
],
'imagePulledAt': datetime(2015, 1, 1),
'lastInUseAt': datetime(2015, 1, 1),
'inUseCount': 123
},
'ec2': {
'tags': {
'string': 'string'
},
'amiId': 'string',
'platform': 'WINDOWS'|'LINUX'|'UNKNOWN'|'MACOS'
},
'lambdaFunction': {
'functionTags': {
'string': 'string'
},
'layers': [
'string',
],
'functionName': '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'|'DOTNET_10'|'NODEJS_24_X'|'NODEJS_22_X'|'JAVA_21'|'JAVA_25'
},
'codeRepository': {
'projectName': 'string',
'integrationArn': 'string',
'providerType': 'string',
'providerTypeVisibility': 'string',
'lastScannedCommitId': 'string',
'scanConfiguration': {
'periodicScanConfigurations': [
{
'frequencyExpression': 'string',
'ruleSetCategories': [
'SAST'|'IAC'|'SCA',
]
},
],
'continuousIntegrationScanConfigurations': [
{
'supportedEvent': 'PULL_REQUEST'|'PUSH',
'ruleSetCategories': [
'SAST'|'IAC'|'SCA',
]
},
]
},
'onDemandScan': {
'lastScannedCommitId': 'string',
'lastScanAt': datetime(2015, 1, 1),
'scanStatus': {
'statusCode': 'ACTIVE'|'INACTIVE',
'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'|'IMAGE_ARCHIVED'|'UNSUPPORTED_CODE_ARTIFACTS'|'RESOURCE_UNMANAGED'|'RESOURCE_STOPPED'
}
}
},
'vmInstance': {
'tags': {
'string': 'string'
},
'platform': 'WINDOWS'|'LINUX'|'UNKNOWN',
'inventoryHash': 'string',
'vmImageReference': 'string'
},
'containerImage': {
'imageTags': [
'string',
],
'imagePulledAt': datetime(2015, 1, 1),
'lastInUseAt': datetime(2015, 1, 1),
'inUseCount': 123
},
'containerRepository': {
'name': 'string',
'scanFrequency': 'string'
},
'containerRegistry': {
'name': 'string'
},
'serverlessFunction': {
'serverlessFunctionName': 'string',
'runtime': 'string',
'functionTags': {
'string': 'string'
}
}
},
'lastScannedAt': datetime(2015, 1, 1),
'scanMode': 'EC2_SSM_AGENT_BASED'|'EC2_AGENTLESS'|'EC2_INSPECTOR_AGENT_BASED'|'VM_INSPECTOR_AGENT_BASED',
'provider': 'AWS'|'AZURE',
'providerAccountId': 'string',
'providerOrgId': 'string',
'providerRegion': 'string',
'providerPartition': 'string'
},
]
}
Response Structure
(dict) --
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.
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.
resourceType (string) --
The type of the covered resource.
resourceId (string) --
The ID of the covered resource.
accountId (string) --
The Amazon Web Services account ID of the covered resource.
scanType (string) --
The Amazon Inspector scan type covering the resource.
scanStatus (dict) --
The status of the scan covering the resource.
statusCode (string) --
The status code 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_CODE_ARTIFACTS - The function was not scanned because it has an unsupported code artifacts.
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.
IMAGE_ARCHIVED - This image has been archived in Amazon ECR and is no longer available for scanning in Amazon Inspector.
resourceMetadata (dict) --
An object that contains details about the metadata.
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.
ecrImage (dict) --
An object that contains details about the container metadata for an Amazon ECR image.
tags (list) --
Tags associated with the Amazon ECR image metadata.
(string) --
imagePulledAt (datetime) --
The date an image was last pulled at.
lastInUseAt (datetime) --
The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
inUseCount (integer) --
The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
ec2 (dict) --
An object that contains metadata details for an Amazon EC2 instance.
tags (dict) --
The tags attached to the instance.
(string) --
(string) --
amiId (string) --
The ID of the Amazon Machine Image (AMI) used to launch the instance.
platform (string) --
The platform of the instance.
lambdaFunction (dict) --
An object that contains metadata details for an Amazon Web Services Lambda 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) --
functionName (string) --
The name of a function.
runtime (string) --
An Amazon Web Services Lambda function's runtime.
codeRepository (dict) --
Contains metadata about scan coverage for a code repository resource.
projectName (string) --
The name of the project in the code repository.
integrationArn (string) --
The Amazon Resource Name (ARN) of the code security integration associated with the repository.
providerType (string) --
The type of repository provider (such as GitHub, GitLab, etc.).
providerTypeVisibility (string) --
The visibility setting of the repository (public or private).
lastScannedCommitId (string) --
The ID of the last commit that was scanned in the repository.
scanConfiguration (dict) --
The scan configuration settings applied to the code repository.
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) --
continuousIntegrationScanConfigurations (list) --
The continuous integration scan configurations applied to the project.
(dict) --
Contains the continuous integration scan configuration settings applied to a specific project.
supportedEvent (string) --
The repository event that triggers continuous integration scans for the project.
ruleSetCategories (list) --
The categories of security rules applied during continuous integration scans for the project.
(string) --
onDemandScan (dict) --
Information about on-demand scans performed on the repository.
lastScannedCommitId (string) --
The ID of the last commit that was scanned during an on-demand scan.
lastScanAt (datetime) --
The timestamp when the last on-demand scan was performed.
scanStatus (dict) --
The status of the scan.
statusCode (string) --
The status code 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_CODE_ARTIFACTS - The function was not scanned because it has an unsupported code artifacts.
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.
IMAGE_ARCHIVED - This image has been archived in Amazon ECR and is no longer available for scanning in Amazon Inspector.
vmInstance (dict) --
The VM instance metadata associated with a covered resource.
tags (dict) --
The tags associated with the VM instance.
(string) --
(string) --
platform (string) --
The platform of the VM instance.
inventoryHash (string) --
The inventory hash of the VM instance.
vmImageReference (string) --
The image reference of the VM instance.
containerImage (dict) --
The container image metadata associated with a covered resource.
imageTags (list) --
The tags attached to the container image.
(string) --
imagePulledAt (datetime) --
The date and time the container image was pulled.
lastInUseAt (datetime) --
The last time the container image was in use.
inUseCount (integer) --
The number of times the container image is in use.
containerRepository (dict) --
The container repository metadata associated with a covered resource.
name (string) --
The name of the container repository.
scanFrequency (string) --
The scan frequency for the container repository.
containerRegistry (dict) --
The container registry metadata associated with a covered resource.
name (string) --
The name of the container registry.
serverlessFunction (dict) --
The serverless function metadata associated with a covered resource.
serverlessFunctionName (string) --
The name of the serverless function.
runtime (string) --
The runtime of the serverless function.
functionTags (dict) --
The tags associated with the serverless function.
(string) --
(string) --
lastScannedAt (datetime) --
The date and time the resource was last checked for vulnerabilities.
scanMode (string) --
The scan method that is applied to the instance.
provider (string) --
The cloud provider of the covered resource.
providerAccountId (string) --
The cloud provider account ID of the covered resource.
providerOrgId (string) --
The cloud provider organization ID of the covered resource.
providerRegion (string) --
The cloud provider region of the covered resource.
providerPartition (string) --
The cloud provider partition of the covered resource.
{'filterCriteria': {'cloudContainerImageTags': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudContainerRegistryName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudContainerRepositoryName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionTags': [{'comparison': 'EQUALS',
'key': 'string',
'value': 'string'}],
'cloudVmInstanceTags': [{'comparison': 'EQUALS',
'key': 'string',
'value': 'string'}]},
'groupBy': {'PROVIDER',
'PROVIDER_ACCOUNT_ID',
'PROVIDER_ORG_ID',
'PROVIDER_REGION'}}
Response {'countsByGroup': {'groupKey': {'PROVIDER',
'PROVIDER_ACCOUNT_ID',
'PROVIDER_ORG_ID',
'PROVIDER_REGION'}}}
Lists Amazon Inspector coverage statistics for your environment.
See also: AWS API Documentation
Request Syntax
client.list_coverage_statistics(
filterCriteria={
'scanStatusCode': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'scanStatusReason': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'accountId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'scanType': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrRepositoryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'lastScannedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'scanMode': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'imagePulledAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123,
'lowerInclusive': 123
},
],
'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'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmInstanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'cloudContainerImageTags': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudContainerRepositoryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudContainerRegistryName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'NOT_EQUALS',
'value': 'string'
},
]
},
groupBy='SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME'|'PROVIDER'|'PROVIDER_ACCOUNT_ID'|'PROVIDER_REGION'|'PROVIDER_ORG_ID',
nextToken='string'
)
dict
An object that contains details on the filters to apply to the coverage data for your environment.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
scanMode (list) --
The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED, EC2_AGENTLESS, and EC2_INSPECTOR_AGENT_BASED.
(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.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
ecrImageLastInUseAt (list) --
The Amazon ECR image that was last in use.
(dict) --
Contains details of a coverage date filter.
startInclusive (datetime) --
A timestamp representing the start of the time period to filter results by.
endInclusive (datetime) --
A timestamp representing the end of the time period to filter results by.
ecrImageInUseCount (list) --
The number of Amazon ECR images in use.
(dict) --
The coverage number to be used in the filter.
upperInclusive (integer) --
The upper inclusive for the coverage number.>
lowerInclusive (integer) --
The lower inclusive for the coverage number.
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.
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.
cloudProvider (list) --
The cloud provider to filter coverage results by.
(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.
cloudProviderAccountId (list) --
The cloud provider account ID to filter coverage results by.
(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.
cloudProviderRegion (list) --
The cloud provider region to filter coverage results by.
(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.
cloudVmInstanceTags (list) --
The cloud VM instance tags to filter coverage results by.
(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.
cloudContainerImageTags (list) --
The cloud container image tags to filter coverage results by.
(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.
cloudContainerRepositoryName (list) --
The cloud container repository name to filter coverage results by.
(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.
cloudContainerRegistryName (list) --
The cloud container registry name to filter coverage results by.
(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.
cloudServerlessFunctionName (list) --
The cloud serverless function name to filter coverage results by.
(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.
cloudServerlessFunctionRuntime (list) --
The cloud serverless function runtime to filter coverage results by.
(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.
cloudServerlessFunctionTags (list) --
The cloud serverless function tags to filter coverage results by.
(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.
cloudProviderOrgId (list) --
The cloud provider organization ID to filter coverage results by.
(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.
string
The value to group the results by.
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.
dict
Response Syntax
{
'countsByGroup': [
{
'count': 123,
'groupKey': 'SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME'|'PROVIDER'|'PROVIDER_ACCOUNT_ID'|'PROVIDER_REGION'|'PROVIDER_ORG_ID'
},
],
'totalCounts': 123,
'nextToken': 'string'
}
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
totalCounts (integer) --
The total number for all groups.
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.
{'filters': {'criteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}]}}}
Lists the filters associated with your account.
See also: AWS API Documentation
Request Syntax
client.list_filters(
arns=[
'string',
],
action='NONE'|'SUPPRESS',
nextToken='string',
maxResults=123
)
list
The Amazon resource number (ARN) of the filter.
(string) --
string
The action the filter applies to matched findings.
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. 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.
integer
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.
dict
Response Syntax
{
'filters': [
{
'arn': 'string',
'ownerId': 'string',
'name': 'string',
'criteria': {
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
},
'action': 'NONE'|'SUPPRESS',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'description': 'string',
'reason': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
filters (list) --
Contains details on the filters associated with your account.
(dict) --
Details about a filter.
arn (string) --
The Amazon Resource Number (ARN) associated with this filter.
ownerId (string) --
The Amazon Web Services account ID of the account that created the filter.
name (string) --
The name of the filter.
criteria (dict) --
Details on the filter criteria associated with this filter.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
action (string) --
The action that is to be applied to the findings that match the filter.
createdAt (datetime) --
The date and time this filter was created at.
updatedAt (datetime) --
The date and time the filter was last updated at.
description (string) --
A description of the filter.
reason (string) --
The reason for the filter.
tags (dict) --
The tags attached to the filter.
(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 to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
{'aggregationRequest': {'accountAggregation': {'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}},
'containerImageAggregation': {'architectures': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudAccountIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudOrgIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudPartitions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviders': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudRegions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'imageDigests': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'imageTags': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'inUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'lastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'registries': [{'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'},
'findingTypeAggregation': {'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}},
'imageLayerAggregation': {'cloudAccountIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudOrgIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudPartitions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviders': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudRegions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}]},
'serverlessFunctionAggregation': {'cloudAccountIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudOrgIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudPartitions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviders': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudRegions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'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'},
'titleAggregation': {'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}},
'vmInstanceAggregation': {'cloudAccountIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudOrgIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudPartitions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviders': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudRegions': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'instanceTags': [{'comparison': 'EQUALS',
'key': 'string',
'value': 'string'}],
'operatingSystems': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'resourceIds': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'sortBy': 'CRITICAL | HIGH | '
'ALL | '
'NETWORK_FINDINGS',
'sortOrder': 'ASC | DESC',
'vmImageReferences': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}]}},
'aggregationType': {'SERVERLESS_FUNCTION', 'CONTAINER_IMAGE', 'VM_INSTANCE'}}
Response {'aggregationType': {'SERVERLESS_FUNCTION', 'CONTAINER_IMAGE', 'VM_INSTANCE'},
'responses': {'amiAggregation': {'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'AWS | AZURE',
'cloudRegion': 'string'},
'containerImageAggregation': {'accountId': 'string',
'architecture': 'string',
'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'AWS | AZURE',
'cloudRegion': 'string',
'exploitAvailableActiveFindingsCount': 'long',
'fixAvailableActiveFindingsCount': 'long',
'imageDigest': 'string',
'imageTags': ['string'],
'inUseCount': 'long',
'lastInUseAt': 'timestamp',
'registry': 'string',
'repository': 'string',
'resourceId': 'string',
'severityCounts': {'all': 'long',
'critical': 'long',
'high': 'long',
'medium': 'long'}},
'findingTypeAggregation': {'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'string',
'cloudRegion': 'string'},
'imageLayerAggregation': {'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'string',
'cloudRegion': 'string'},
'repositoryAggregation': {'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'AWS | AZURE',
'cloudRegion': 'string'},
'serverlessFunctionAggregation': {'accountId': 'string',
'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'AWS | AZURE',
'cloudRegion': 'string',
'exploitAvailableActiveFindingsCount': 'long',
'fixAvailableActiveFindingsCount': 'long',
'functionName': 'string',
'lastModifiedAt': 'timestamp',
'resourceId': 'string',
'runtime': 'string',
'severityCounts': {'all': 'long',
'critical': 'long',
'high': 'long',
'medium': 'long'},
'tags': {'string': 'string'}},
'vmInstanceAggregation': {'accountId': 'string',
'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudPartition': 'string',
'cloudProvider': 'AWS | AZURE',
'cloudRegion': 'string',
'exploitAvailableActiveFindingsCount': 'long',
'fixAvailableActiveFindingsCount': 'long',
'networkFindings': 'long',
'operatingSystem': 'string',
'resourceId': 'string',
'severityCounts': {'all': 'long',
'critical': 'long',
'high': 'long',
'medium': 'long'},
'tags': {'string': 'string'},
'vmImageReference': 'string'}}}
Lists aggregated finding data for your environment based on specific criteria.
See also: AWS API Documentation
Request Syntax
client.list_finding_aggregations(
aggregationType='FINDING_TYPE'|'PACKAGE'|'TITLE'|'REPOSITORY'|'AMI'|'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER'|'IMAGE_LAYER'|'ACCOUNT'|'AWS_LAMBDA_FUNCTION'|'LAMBDA_LAYER'|'CODE_REPOSITORY'|'VM_INSTANCE'|'CONTAINER_IMAGE'|'SERVERLESS_FUNCTION',
nextToken='string',
maxResults=123,
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'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites',
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'amiAggregation': {
'amis': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'|'AFFECTED_INSTANCES'
},
'awsEcrContainerAggregation': {
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'imageShas': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'repositories': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'architectures': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'imageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL',
'lastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'inUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
]
},
'ec2InstanceAggregation': {
'amis': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'operatingSystems': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'instanceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'instanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'NETWORK_FINDINGS'|'CRITICAL'|'HIGH'|'ALL'
},
'findingTypeAggregation': {
'findingType': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites',
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'imageLayerAggregation': {
'repositories': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'layerHashes': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviders': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudAccountIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudOrgIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudRegions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudPartitions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'packageAggregation': {
'packageNames': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'repositoryAggregation': {
'repositories': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'|'AFFECTED_IMAGES'
},
'titleAggregation': {
'titles': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites',
'findingType': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'lambdaLayerAggregation': {
'functionNames': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'layerArns': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'lambdaFunctionAggregation': {
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'functionNames': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'runtimes': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'functionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'codeRepositoryAggregation': {
'projectNames': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'providerTypes': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL',
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
},
'vmInstanceAggregation': {
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'operatingSystems': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'instanceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'vmImageReferences': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviders': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudPartitions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudRegions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudOrgIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudAccountIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'|'NETWORK_FINDINGS'
},
'containerImageAggregation': {
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'imageDigests': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'repositories': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'registries': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'architectures': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'imageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviders': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudPartitions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudRegions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudOrgIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudAccountIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'inUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
},
'serverlessFunctionAggregation': {
'resourceIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'functionNames': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'runtimes': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'functionTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'cloudProviders': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudPartitions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudRegions': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudOrgIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudAccountIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'sortOrder': 'ASC'|'DESC',
'sortBy': 'CRITICAL'|'HIGH'|'ALL'
}
}
)
string
[REQUIRED]
The type of the aggregation request.
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. 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.
integer
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.
list
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.
dict
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.
sortOrder (string) --
The sort order (ascending or descending).
sortBy (string) --
The value to sort by.
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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value to sort results by.
awsEcrContainerAggregation (dict) --
An object that contains details about an aggregation request based on Amazon ECR container images.
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.
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.
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.
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.
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.
sortOrder (string) --
The sort order (ascending or descending).
sortBy (string) --
The value to sort by.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value 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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value to sort results by.
imageLayerAggregation (dict) --
An object that contains details about an aggregation request based on container image layers.
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.
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.
cloudProviders (list) --
The cloud providers to aggregate findings for. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
(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.
cloudAccountIds (list) --
The cloud account 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.
cloudOrgIds (list) --
The cloud organization 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.
cloudRegions (list) --
The cloud regions to aggregate findings for. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
(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.
cloudPartitions (list) --
The cloud partitions to aggregate findings for. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
(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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value to sort results by.
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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value 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.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value to sort results by.
titleAggregation (dict) --
An object that contains details about an aggregation request based on finding title.
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.
resourceType (string) --
The resource type to aggregate on.
findingType (string) --
The type of finding to aggregate on.
sortOrder (string) --
The order to sort results by.
sortBy (string) --
The value to sort results by.
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.
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.
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.
sortOrder (string) --
The order to use for sorting the results.
sortBy (string) --
The finding severity to use for sorting the results.
lambdaFunctionAggregation (dict) --
Returns an object with findings aggregated by Amazon Web Services Lambda function.
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.
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.
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.
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.
sortOrder (string) --
The order to use for sorting the results.
sortBy (string) --
The finding severity to use for sorting the results.
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.
sortOrder (string) --
The order to sort results by (ascending or descending) in the code repository aggregation.
sortBy (string) --
The value to sort results by in the code repository aggregation.
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.
vmInstanceAggregation (dict) --
An object that contains details about an aggregation request based on virtual machine (VM) instances.
resourceIds (list) --
The resource 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.
operatingSystems (list) --
The operating systems 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 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.
vmImageReferences (list) --
The VM image references 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.
cloudProviders (list) --
The cloud providers to aggregate findings for. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
(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.
cloudPartitions (list) --
The cloud partitions to aggregate findings for. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
(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.
cloudRegions (list) --
The cloud regions to aggregate findings for. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
(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.
cloudOrgIds (list) --
The cloud organization 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.
cloudAccountIds (list) --
The cloud account 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.
sortOrder (string) --
The order to sort results by. Valid values are ASC and DESC.
sortBy (string) --
The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, ALL, or NETWORK_FINDINGS.
containerImageAggregation (dict) --
An object that contains details about an aggregation request based on container images.
resourceIds (list) --
The resource 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.
imageDigests (list) --
The image digests 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.
repositories (list) --
The image repositories 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.
registries (list) --
The image registries 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.
architectures (list) --
The image architectures 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.
imageTags (list) --
The image tags 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.
cloudProviders (list) --
The cloud providers to aggregate findings for. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
(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.
cloudPartitions (list) --
The cloud partitions to aggregate findings for. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
(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.
cloudRegions (list) --
The cloud regions to aggregate findings for. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
(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.
cloudOrgIds (list) --
The cloud organization 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.
cloudAccountIds (list) --
The cloud account 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.
lastInUseAt (list) --
The last in-use timestamps to aggregate findings for.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
inUseCount (list) --
The in-use counts to aggregate findings for.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
sortOrder (string) --
The order to sort results by. Valid values are ASC and DESC.
sortBy (string) --
The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.
serverlessFunctionAggregation (dict) --
An object that contains details about an aggregation request based on serverless functions.
resourceIds (list) --
The resource 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.
functionNames (list) --
The function names 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.
runtimes (list) --
The runtimes 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.
functionTags (list) --
The function 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.
cloudProviders (list) --
The cloud providers to aggregate findings for. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
(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.
cloudPartitions (list) --
The cloud partitions to aggregate findings for. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
(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.
cloudRegions (list) --
The cloud regions to aggregate findings for. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
(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.
cloudOrgIds (list) --
The cloud organization 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.
cloudAccountIds (list) --
The cloud account 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.
sortOrder (string) --
The order to sort results by. Valid values are ASC and DESC.
sortBy (string) --
The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.
dict
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'|'VM_INSTANCE'|'CONTAINER_IMAGE'|'SERVERLESS_FUNCTION',
'responses': [
{
'accountAggregation': {
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'exploitAvailableCount': 123,
'fixAvailableCount': 123
},
'amiAggregation': {
'ami': 'string',
'accountId': 'string',
'cloudProvider': 'AWS'|'AZURE',
'cloudPartition': 'string',
'cloudRegion': 'string',
'cloudOrgId': 'string',
'cloudAccountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'affectedInstances': 123
},
'awsEcrContainerAggregation': {
'resourceId': 'string',
'imageSha': 'string',
'repository': 'string',
'architecture': 'string',
'imageTags': [
'string',
],
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'lastInUseAt': datetime(2015, 1, 1),
'inUseCount': 123
},
'ec2InstanceAggregation': {
'instanceId': 'string',
'ami': 'string',
'operatingSystem': 'string',
'instanceTags': {
'string': 'string'
},
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'networkFindings': 123
},
'findingTypeAggregation': {
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'exploitAvailableCount': 123,
'fixAvailableCount': 123,
'cloudProvider': 'string',
'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudRegion': 'string',
'cloudPartition': 'string'
},
'imageLayerAggregation': {
'repository': 'string',
'resourceId': 'string',
'layerHash': 'string',
'accountId': 'string',
'cloudProvider': 'string',
'cloudAccountId': 'string',
'cloudOrgId': 'string',
'cloudRegion': 'string',
'cloudPartition': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
}
},
'packageAggregation': {
'packageName': 'string',
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
}
},
'repositoryAggregation': {
'repository': 'string',
'accountId': 'string',
'cloudProvider': 'AWS'|'AZURE',
'cloudPartition': 'string',
'cloudRegion': 'string',
'cloudOrgId': 'string',
'cloudAccountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'affectedImages': 123
},
'titleAggregation': {
'title': 'string',
'vulnerabilityId': 'string',
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
}
},
'lambdaLayerAggregation': {
'functionName': 'string',
'resourceId': 'string',
'layerArn': 'string',
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
}
},
'lambdaFunctionAggregation': {
'resourceId': 'string',
'functionName': 'string',
'runtime': 'string',
'lambdaTags': {
'string': 'string'
},
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'lastModifiedAt': datetime(2015, 1, 1)
},
'codeRepositoryAggregation': {
'projectNames': 'string',
'providerType': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'exploitAvailableActiveFindingsCount': 123,
'fixAvailableActiveFindingsCount': 123,
'accountId': 'string',
'resourceId': 'string'
},
'vmInstanceAggregation': {
'resourceId': 'string',
'cloudProvider': 'AWS'|'AZURE',
'cloudAccountId': 'string',
'cloudPartition': 'string',
'cloudRegion': 'string',
'cloudOrgId': 'string',
'vmImageReference': 'string',
'operatingSystem': 'string',
'tags': {
'string': 'string'
},
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'networkFindings': 123,
'exploitAvailableActiveFindingsCount': 123,
'fixAvailableActiveFindingsCount': 123
},
'containerImageAggregation': {
'resourceId': 'string',
'cloudProvider': 'AWS'|'AZURE',
'cloudAccountId': 'string',
'cloudPartition': 'string',
'cloudRegion': 'string',
'cloudOrgId': 'string',
'imageDigest': 'string',
'repository': 'string',
'registry': 'string',
'architecture': 'string',
'imageTags': [
'string',
],
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'lastInUseAt': datetime(2015, 1, 1),
'inUseCount': 123,
'exploitAvailableActiveFindingsCount': 123,
'fixAvailableActiveFindingsCount': 123
},
'serverlessFunctionAggregation': {
'resourceId': 'string',
'cloudProvider': 'AWS'|'AZURE',
'cloudAccountId': 'string',
'cloudPartition': 'string',
'cloudRegion': 'string',
'cloudOrgId': 'string',
'functionName': 'string',
'runtime': 'string',
'tags': {
'string': 'string'
},
'accountId': 'string',
'severityCounts': {
'all': 123,
'medium': 123,
'high': 123,
'critical': 123
},
'lastModifiedAt': datetime(2015, 1, 1),
'exploitAvailableActiveFindingsCount': 123,
'fixAvailableActiveFindingsCount': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
aggregationType (string) --
The type of aggregation to perform.
responses (list) --
Objects that contain the results of an aggregation operation.
(dict) --
A structure that contains details about the results of an aggregation type.
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.
severityCounts (dict) --
The number of findings by severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
exploitAvailableCount (integer) --
The number of findings that have an exploit available.
fixAvailableCount (integer) --
Details about the number of fixes.
amiAggregation (dict) --
An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).
ami (string) --
The ID of the AMI that findings were aggregated for.
accountId (string) --
The Amazon Web Services account ID for the AMI.
cloudProvider (string) --
The cloud service provider associated with this Amazon Machine Image (AMI) aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudPartition (string) --
The cloud infrastructure partition associated with this AMI aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
cloudRegion (string) --
The cloud Region associated with this AMI aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudOrgId (string) --
The cloud organization ID for the AMI aggregation.
cloudAccountId (string) --
The cloud account ID for the AMI aggregation.
severityCounts (dict) --
An object that contains the count of matched findings per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
affectedInstances (integer) --
The IDs of Amazon EC2 instances using this AMI.
awsEcrContainerAggregation (dict) --
An object that contains details about an aggregation response based on Amazon ECR container images.
resourceId (string) --
The resource ID of the container.
imageSha (string) --
The SHA value of the container image.
repository (string) --
The container repository.
architecture (string) --
The architecture of the container.
imageTags (list) --
The container image stags.
(string) --
accountId (string) --
The Amazon Web Services account ID of the account that owns the container.
severityCounts (dict) --
The number of finding by severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lastInUseAt (datetime) --
The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
inUseCount (integer) --
The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
ec2InstanceAggregation (dict) --
An object that contains details about an aggregation response based on Amazon EC2 instances.
instanceId (string) --
The Amazon EC2 instance ID.
ami (string) --
The Amazon Machine Image (AMI) of the Amazon EC2 instance.
operatingSystem (string) --
The operating system of the Amazon EC2 instance.
instanceTags (dict) --
The tags attached to the instance.
(string) --
(string) --
accountId (string) --
The Amazon Web Services account for 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.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
networkFindings (integer) --
The number of network findings for the Amazon EC2 instance.
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.
severityCounts (dict) --
The value to sort results by.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
exploitAvailableCount (integer) --
The number of findings that have an exploit available.
fixAvailableCount (integer) --
Details about the number of fixes.
cloudProvider (string) --
The cloud service provider associated with this finding type aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudAccountId (string) --
The cloud account ID for the finding type aggregation.
cloudOrgId (string) --
The cloud organization ID for the finding type aggregation.
cloudRegion (string) --
The cloud Region associated with this finding type aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudPartition (string) --
The cloud infrastructure partition associated with this finding type aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
imageLayerAggregation (dict) --
An object that contains details about an aggregation response based on container image layers.
repository (string) --
The repository the layer resides in.
resourceId (string) --
The resource ID of the container image layer.
layerHash (string) --
The layer hash.
accountId (string) --
The ID of the Amazon Web Services account that owns the container image hosting the layer image.
cloudProvider (string) --
The cloud service provider associated with this image layer aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudAccountId (string) --
The cloud account ID for the image layer aggregation.
cloudOrgId (string) --
The cloud organization ID for the image layer aggregation.
cloudRegion (string) --
The cloud Region associated with this image layer aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudPartition (string) --
The cloud infrastructure partition associated with this image layer aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
severityCounts (dict) --
An object that represents the count of matched findings per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
packageAggregation (dict) --
An object that contains details about an aggregation response based on operating system package type.
packageName (string) --
The name of the operating system package.
accountId (string) --
The ID of the Amazon Web Services account associated with the findings.
severityCounts (dict) --
An object that contains the count of matched findings per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
repositoryAggregation (dict) --
An object that contains details about an aggregation response based on Amazon ECR repositories.
repository (string) --
The name of the repository associated with the findings.
accountId (string) --
The ID of the Amazon Web Services account associated with the findings.
cloudProvider (string) --
The cloud service provider associated with this repository aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudPartition (string) --
The cloud infrastructure partition associated with this repository aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
cloudRegion (string) --
The cloud Region associated with this repository aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudOrgId (string) --
The cloud organization ID for the repository aggregation.
cloudAccountId (string) --
The cloud account ID for the repository aggregation.
severityCounts (dict) --
An object that represent the count of matched findings per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
affectedImages (integer) --
The number of container images impacted by the findings.
titleAggregation (dict) --
An object that contains details about an aggregation response based on finding title.
title (string) --
The title that the findings were aggregated on.
vulnerabilityId (string) --
The vulnerability ID of the finding.
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.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lambdaLayerAggregation (dict) --
An aggregation of findings by Amazon Web Services Lambda layer.
functionName (string) --
The names of the Amazon Web Services Lambda functions associated with the layers.
resourceId (string) --
The Resource ID of the Amazon Web Services Lambda function layer.
layerArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.
accountId (string) --
The account 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.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lambdaFunctionAggregation (dict) --
An aggregation of findings by Amazon Web Services Lambda function.
resourceId (string) --
The resource IDs included in the aggregation results.
functionName (string) --
The Amazon Web Services Lambda function names included in the aggregation results.
runtime (string) --
The runtimes included in the aggregation results.
lambdaTags (dict) --
The tags included in the aggregation results.
(string) --
(string) --
accountId (string) --
The ID of the Amazon Web Services account that owns the Amazon Web Services Lambda function.
severityCounts (dict) --
An object that contains the counts of aggregated finding per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lastModifiedAt (datetime) --
The date that the Amazon Web Services Lambda function included in the aggregation results was last changed.
codeRepositoryAggregation (dict) --
An object that contains details about an aggregation response based on code repositories.
projectNames (string) --
The names of the projects associated with the code repository.
providerType (string) --
The type of repository provider for 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.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
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.
accountId (string) --
The Amazon Web Services account ID associated with the code repository.
resourceId (string) --
The resource ID of the code repository.
vmInstanceAggregation (dict) --
An object that contains details about an aggregation response based on VM instances.
resourceId (string) --
The resource ID for the VM instance.
cloudProvider (string) --
The cloud service provider associated with this VM instance aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudAccountId (string) --
The cloud account ID for the VM instance aggregation.
cloudPartition (string) --
The cloud infrastructure partition associated with this VM instance aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
cloudRegion (string) --
The cloud Region associated with this VM instance aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudOrgId (string) --
The cloud organization ID for the VM instance aggregation.
vmImageReference (string) --
The VM image reference for the VM instance.
operatingSystem (string) --
The operating system of the VM instance.
tags (dict) --
The tags attached to the VM instance.
(string) --
(string) --
accountId (string) --
The account ID associated with the VM instance.
severityCounts (dict) --
An object that contains the counts of aggregated finding per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
networkFindings (integer) --
The number of network findings for the VM instance. This field applies only to Amazon Web Services resources.
exploitAvailableActiveFindingsCount (integer) --
The number of active findings with an exploit available for the VM instance.
fixAvailableActiveFindingsCount (integer) --
The number of active findings with a fix available for the VM instance.
containerImageAggregation (dict) --
An object that contains details about an aggregation response based on container images.
resourceId (string) --
The resource ID for the container image.
cloudProvider (string) --
The cloud service provider associated with this container image aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudAccountId (string) --
The cloud account ID for the container image aggregation.
cloudPartition (string) --
The cloud infrastructure partition associated with this container image aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
cloudRegion (string) --
The cloud Region associated with this container image aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudOrgId (string) --
The cloud organization ID for the container image aggregation.
imageDigest (string) --
The image digest for the container image.
repository (string) --
The repository for the container image.
registry (string) --
The registry for the container image.
architecture (string) --
The architecture of the container image.
imageTags (list) --
The image tags attached to the container image.
(string) --
accountId (string) --
The account ID associated with the container image.
severityCounts (dict) --
An object that contains the counts of aggregated finding per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lastInUseAt (datetime) --
The last time the container image was in use.
inUseCount (integer) --
The number of times the container image is in use.
exploitAvailableActiveFindingsCount (integer) --
The number of active findings with an exploit available for the container image.
fixAvailableActiveFindingsCount (integer) --
The number of active findings with a fix available for the container image.
serverlessFunctionAggregation (dict) --
An object that contains details about an aggregation response based on serverless functions.
resourceId (string) --
The resource ID for the serverless function.
cloudProvider (string) --
The cloud service provider associated with this serverless function aggregation. Valid values:
AWS – Findings from Amazon Web Services resources.
AZURE – Findings from Microsoft Azure resources.
cloudAccountId (string) --
The cloud account ID for the serverless function aggregation.
cloudPartition (string) --
The cloud infrastructure partition associated with this serverless function aggregation. Valid values:
aws – Amazon Web Services commercial Regions.
aws-cn – Amazon Web Services China Regions.
aws-us-gov – Amazon Web Services GovCloud (US) Regions.
AzureCloud – Azure commercial Regions.
cloudRegion (string) --
The cloud Region associated with this serverless function aggregation. The value format depends on the cloud provider:
An Amazon Web Services Region, such as us-east-1.
An Azure region, such as eastus.
cloudOrgId (string) --
The cloud organization ID for the serverless function aggregation.
functionName (string) --
The name of the serverless function.
runtime (string) --
The runtime of the serverless function.
tags (dict) --
The tags attached to the serverless function.
(string) --
(string) --
accountId (string) --
The account ID associated with the serverless function.
severityCounts (dict) --
An object that contains the counts of aggregated finding per severity.
all (integer) --
The total count of findings from all severities.
medium (integer) --
The total count of medium severity findings.
high (integer) --
The total count of high severity findings.
critical (integer) --
The total count of critical severity findings.
lastModifiedAt (datetime) --
The date and time the serverless function was last modified.
exploitAvailableActiveFindingsCount (integer) --
The number of active findings with an exploit available for the serverless function.
fixAvailableActiveFindingsCount (integer) --
The number of active findings with a fix available for the serverless function.
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.
{'filterCriteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}]}}
Response {'findings': {'resources': {'details': {'awsLambdaFunction': {'runtime': {'JAVA_21',
'JAVA_25',
'NODEJS_22_X'}},
'image': {'architecture': 'string',
'author': 'string',
'imageDigest': 'string',
'imageTags': ['string'],
'inUseCount': 'long',
'lastInUseAt': 'timestamp',
'platform': 'string',
'pushedAt': 'timestamp',
'registry': 'string',
'repositoryName': 'string'},
'serverlessFunction': {'architectures': ['X86_64 '
'| '
'ARM64'],
'codeDigest': 'string',
'executionRole': 'string',
'lastModifiedAt': 'timestamp',
'layers': ['string'],
'networkId': 'string',
'packageType': 'IMAGE '
'| '
'ZIP',
'runtime': 'string',
'securityGroupIds': ['string'],
'serverlessFunctionName': 'string',
'subnetIds': ['string'],
'version': 'string'},
'vm': {'executionRole': 'string',
'ipV4Addresses': ['string'],
'ipV6Addresses': ['string'],
'keyName': 'string',
'launchedAt': 'timestamp',
'networkId': 'string',
'platform': 'string',
'securityGroupIds': ['string'],
'subnetIds': ['string'],
'type': 'string',
'vmImageReference': 'string',
'vmName': 'string'}},
'provider': 'AWS | AZURE',
'providerAccountId': 'string',
'providerOrgId': 'string',
'type': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}}}}
Lists findings for your environment.
See also: AWS API Documentation
Request Syntax
client.list_findings(
maxResults=123,
nextToken='string',
filterCriteria={
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': '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'
}
)
integer
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.
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. 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.
dict
Details on the filters to apply to your finding results.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
dict
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.
dict
Response Syntax
{
'nextToken': 'string',
'findings': [
{
'findingArn': 'string',
'awsAccountId': 'string',
'type': 'NETWORK_REACHABILITY'|'PACKAGE_VULNERABILITY'|'CODE_VULNERABILITY',
'description': 'string',
'title': 'string',
'remediation': {
'recommendation': {
'text': 'string',
'Url': 'string'
}
},
'severity': 'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'|'UNTRIAGED',
'firstObservedAt': datetime(2015, 1, 1),
'lastObservedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'ACTIVE'|'SUPPRESSED'|'CLOSED',
'resources': [
{
'type': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites',
'id': 'string',
'partition': 'string',
'region': 'string',
'tags': {
'string': 'string'
},
'details': {
'awsEc2Instance': {
'type': 'string',
'imageId': 'string',
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
],
'keyName': 'string',
'iamInstanceProfileArn': 'string',
'vpcId': 'string',
'subnetId': 'string',
'launchedAt': datetime(2015, 1, 1),
'platform': 'string'
},
'awsEcrContainerImage': {
'repositoryName': 'string',
'imageTags': [
'string',
],
'pushedAt': datetime(2015, 1, 1),
'author': 'string',
'architecture': 'string',
'imageHash': 'string',
'registry': 'string',
'platform': 'string',
'lastInUseAt': datetime(2015, 1, 1),
'inUseCount': 123
},
'awsLambdaFunction': {
'functionName': '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'|'DOTNET_10'|'NODEJS_24_X'|'NODEJS_22_X'|'JAVA_21'|'JAVA_25',
'codeSha256': 'string',
'version': 'string',
'executionRoleArn': 'string',
'layers': [
'string',
],
'vpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'vpcId': 'string'
},
'packageType': 'IMAGE'|'ZIP',
'architectures': [
'X86_64'|'ARM64',
],
'lastModifiedAt': datetime(2015, 1, 1)
},
'codeRepository': {
'projectName': 'string',
'integrationArn': 'string',
'providerType': 'GITHUB'|'GITLAB_SELF_MANAGED'
},
'vm': {
'type': 'string',
'vmName': 'string',
'vmImageReference': 'string',
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
],
'networkId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'launchedAt': datetime(2015, 1, 1),
'platform': 'string',
'executionRole': 'string',
'keyName': 'string'
},
'image': {
'repositoryName': 'string',
'registry': 'string',
'imageTags': [
'string',
],
'imageDigest': 'string',
'pushedAt': datetime(2015, 1, 1),
'architecture': 'string',
'author': 'string',
'inUseCount': 123,
'lastInUseAt': datetime(2015, 1, 1),
'platform': 'string'
},
'serverlessFunction': {
'serverlessFunctionName': 'string',
'runtime': 'string',
'version': 'string',
'codeDigest': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'networkId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'executionRole': 'string',
'packageType': 'IMAGE'|'ZIP',
'architectures': [
'X86_64'|'ARM64',
],
'layers': [
'string',
]
}
},
'provider': 'AWS'|'AZURE',
'providerAccountId': 'string',
'providerOrgId': 'string'
},
],
'inspectorScore': 123.0,
'inspectorScoreDetails': {
'adjustedCvss': {
'scoreSource': 'string',
'cvssSource': 'string',
'version': 'string',
'score': 123.0,
'scoringVector': 'string',
'adjustments': [
{
'metric': 'string',
'reason': 'string'
},
]
}
},
'networkReachabilityDetails': {
'openPortRange': {
'begin': 123,
'end': 123
},
'protocol': 'TCP'|'UDP',
'networkPath': {
'steps': [
{
'componentId': 'string',
'componentType': 'string',
'componentArn': 'string'
},
]
}
},
'packageVulnerabilityDetails': {
'vulnerabilityId': 'string',
'vulnerablePackages': [
{
'name': 'string',
'version': 'string',
'sourceLayerHash': 'string',
'epoch': 123,
'release': 'string',
'arch': 'string',
'packageManager': 'BUNDLER'|'CARGO'|'COMPOSER'|'NPM'|'NUGET'|'PIPENV'|'POETRY'|'YARN'|'GOBINARY'|'GOMOD'|'JAR'|'OS'|'PIP'|'PYTHONPKG'|'NODEPKG'|'POM'|'GEMSPEC'|'DOTNET_CORE',
'filePath': 'string',
'fixedInVersion': 'string',
'remediation': 'string',
'sourceLambdaLayerArn': 'string'
},
],
'source': 'string',
'cvss': [
{
'baseScore': 123.0,
'scoringVector': 'string',
'version': 'string',
'source': 'string'
},
],
'relatedVulnerabilities': [
'string',
],
'sourceUrl': 'string',
'vendorSeverity': 'string',
'vendorCreatedAt': datetime(2015, 1, 1),
'vendorUpdatedAt': datetime(2015, 1, 1),
'referenceUrls': [
'string',
]
},
'fixAvailable': 'YES'|'NO'|'PARTIAL',
'exploitAvailable': 'YES'|'NO',
'exploitabilityDetails': {
'lastKnownExploitAt': datetime(2015, 1, 1)
},
'codeVulnerabilityDetails': {
'filePath': {
'fileName': 'string',
'filePath': 'string',
'startLine': 123,
'endLine': 123
},
'detectorTags': [
'string',
],
'referenceUrls': [
'string',
],
'ruleId': 'string',
'sourceLambdaLayerArn': 'string',
'detectorId': 'string',
'detectorName': 'string',
'cwes': [
'string',
]
},
'epss': {
'score': 123.0
}
},
]
}
Response Structure
(dict) --
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.
findings (list) --
Contains details on the findings in your environment.
(dict) --
Details about an Amazon Inspector finding.
findingArn (string) --
The Amazon Resource Number (ARN) of the finding.
awsAccountId (string) --
The Amazon Web Services account ID associated with 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.
description (string) --
The description of the finding.
title (string) --
The title of the finding.
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.
text (string) --
The recommended course of action to remediate the finding.
Url (string) --
The URL address to the CVE remediation recommendations.
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.
firstObservedAt (datetime) --
The date and time that the finding was first observed.
lastObservedAt (datetime) --
The date and time the finding was last observed. This timestamp for this field remains unchanged until a finding is updated.
updatedAt (datetime) --
The date and time the finding was last updated at.
status (string) --
The status of 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.
type (string) --
The type of resource.
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) --
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.
type (string) --
The type 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.
iamInstanceProfileArn (string) --
The IAM instance profile ARN of the Amazon EC2 instance.
vpcId (string) --
The VPC ID of the Amazon EC2 instance.
subnetId (string) --
The subnet ID of 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.
awsEcrContainerImage (dict) --
An object that contains details about the Amazon ECR container image involved in the finding.
repositoryName (string) --
The name of the repository the Amazon ECR container image resides in.
imageTags (list) --
The image tags attached to the Amazon ECR container image.
(string) --
pushedAt (datetime) --
The date and time the Amazon ECR container image was pushed.
author (string) --
The image author of the Amazon ECR container image.
architecture (string) --
The architecture of the Amazon ECR container image.
imageHash (string) --
The image hash of the Amazon ECR container image.
registry (string) --
The registry for the Amazon ECR container image.
platform (string) --
The platform of the Amazon ECR container image.
lastInUseAt (datetime) --
The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
inUseCount (integer) --
The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
awsLambdaFunction (dict) --
A summary of the information about an Amazon Web Services Lambda function affected by a finding.
functionName (string) --
The name of the Amazon Web Services Lambda function.
runtime (string) --
The runtime environment for the Amazon Web Services Lambda function.
codeSha256 (string) --
The SHA256 hash of the Amazon Web Services Lambda function's deployment package.
version (string) --
The version of the Amazon Web Services Lambda function.
executionRoleArn (string) --
The Amazon Web Services Lambda function's execution role.
layers (list) --
The Amazon Web Services Lambda function's layers. A Lambda function can have up to five layers.
(string) --
vpcConfig (dict) --
The Amazon Web Services Lambda function's networking configuration.
subnetIds (list) --
A list of VPC subnet IDs.
(string) --
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) --
vpcId (string) --
The ID of the VPC.
packageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
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) --
lastModifiedAt (datetime) --
The date and time that a user last updated the configuration, in ISO 8601 format
codeRepository (dict) --
Contains details about a code repository resource associated with a finding.
projectName (string) --
The name of the project in the code repository.
integrationArn (string) --
The Amazon Resource Name (ARN) of the code security integration associated with the repository.
providerType (string) --
The type of repository provider (such as GitHub, GitLab, etc.).
vm (dict) --
An object that contains details about a VM instance involved in the finding.
type (string) --
The type of the VM instance.
vmName (string) --
The name of the VM instance.
vmImageReference (string) --
The image reference of the VM instance.
ipV4Addresses (list) --
The IPv4 addresses of the VM instance.
(string) --
ipV6Addresses (list) --
The IPv6 addresses of the VM instance.
(string) --
networkId (string) --
The network ID associated with the VM instance.
subnetIds (list) --
The subnet IDs of the VM instance.
(string) --
securityGroupIds (list) --
The security group IDs associated with the VM instance.
(string) --
launchedAt (datetime) --
The date and time the VM instance was launched.
platform (string) --
The platform of the VM instance.
executionRole (string) --
The execution role of the VM instance.
keyName (string) --
The key name associated with the VM instance.
image (dict) --
An object that contains details about a container image involved in the finding.
repositoryName (string) --
The name of the repository the container image resides in.
registry (string) --
The registry for the container image.
imageTags (list) --
The image tags attached to the container image.
(string) --
imageDigest (string) --
The image digest of the container image.
pushedAt (datetime) --
The date and time the container image was pushed.
architecture (string) --
The architecture of the container image.
author (string) --
The author of the container image.
inUseCount (integer) --
The number of times the container image is in use.
lastInUseAt (datetime) --
The last time the container image was in use.
platform (string) --
The platform of the container image.
serverlessFunction (dict) --
An object that contains details about a serverless function involved in the finding.
serverlessFunctionName (string) --
The name of the serverless function.
runtime (string) --
The runtime of the serverless function.
version (string) --
The version of the serverless function.
codeDigest (string) --
The code digest of the serverless function.
lastModifiedAt (datetime) --
The date and time the serverless function was last modified.
networkId (string) --
The network ID associated with the serverless function.
subnetIds (list) --
The subnet IDs associated with the serverless function.
(string) --
securityGroupIds (list) --
The security group IDs associated with the serverless function.
(string) --
executionRole (string) --
The execution role of the serverless function.
packageType (string) --
The package type of the serverless function.
architectures (list) --
The architectures of the serverless function.
(string) --
layers (list) --
The layers of the serverless function.
(string) --
provider (string) --
The cloud provider of the resource.
providerAccountId (string) --
The cloud provider account ID of the resource.
providerOrgId (string) --
The cloud provider organization ID of the resource.
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.
scoreSource (string) --
The source for the CVSS score.
cvssSource (string) --
The source of the CVSS data.
version (string) --
The CVSS version used in scoring.
score (float) --
The CVSS score.
scoringVector (string) --
The vector for the CVSS score.
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.
networkReachabilityDetails (dict) --
An object that contains the details of a network reachability finding.
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.
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.
componentId (string) --
The component ID.
componentType (string) --
The component type.
componentArn (string) --
The component ARN. The ARN can be null and is not displayed in the Amazon Web Services console.
packageVulnerabilityDetails (dict) --
An object that contains the details of a package vulnerability finding.
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.
name (string) --
The name of the vulnerable package.
version (string) --
The version of the vulnerable package.
sourceLayerHash (string) --
The source layer hash of the vulnerable package.
epoch (integer) --
The epoch of the vulnerable package.
release (string) --
The release of the vulnerable package.
arch (string) --
The architecture of the vulnerable package.
packageManager (string) --
The package manager 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.
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.
source (string) --
The source of the vulnerability information.
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.
version (string) --
The version of CVSS used for the score.
source (string) --
The source of the CVSS score.
relatedVulnerabilities (list) --
One or more vulnerabilities related to the one identified in this finding.
(string) --
sourceUrl (string) --
A URL to the source of the vulnerability information.
vendorSeverity (string) --
The severity the vendor has given to this vulnerability type.
vendorCreatedAt (datetime) --
The date and time that this vulnerability was first added to the vendor's database.
vendorUpdatedAt (datetime) --
The date and time the vendor last updated this vulnerability in their database.
referenceUrls (list) --
One or more URLs that contain details about this vulnerability type.
(string) --
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.
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.
codeVulnerabilityDetails (dict) --
Details about the code vulnerability identified in a Lambda function used to filter findings.
filePath (dict) --
Contains information on where the code vulnerability is located in your code.
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.
endLine (integer) --
The line number of the last line of code that a vulnerability was found in.
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) --
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.
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.
cwes (list) --
The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.
(string) --
epss (dict) --
The finding's EPSS score.
score (float) --
The EPSS score.
{'totals': {'usage': {'cloudProvider': 'AWS | AZURE | NOT_APPLICABLE',
'type': {'AZURE_CONTAINER_IMAGE_INITIAL_SCAN',
'AZURE_CONTAINER_IMAGE_RESCAN',
'AZURE_SERVERLESS_FUNCTION_HOURS',
'AZURE_VM_AGENT_BASED_INSTANCE_HOURS'}}}}
Lists the Amazon Inspector usage totals over the last 30 days.
See also: AWS API Documentation
Request Syntax
client.list_usage_totals(
maxResults=123,
nextToken='string',
accountIds=[
'string',
]
)
integer
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.
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. 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.
list
The Amazon Web Services account IDs to retrieve usage totals for.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'totals': [
{
'accountId': 'string',
'usage': [
{
'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'|'EC2_AGENTLESS_INSTANCE_HOURS'|'AZURE_CONTAINER_IMAGE_INITIAL_SCAN'|'AZURE_CONTAINER_IMAGE_RESCAN'|'AZURE_VM_AGENT_BASED_INSTANCE_HOURS'|'AZURE_SERVERLESS_FUNCTION_HOURS',
'total': 123.0,
'estimatedMonthlyCost': 123.0,
'currency': 'USD',
'cloudProvider': 'AWS'|'AZURE'|'NOT_APPLICABLE'
},
]
},
]
}
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.
type (string) --
The type scan.
total (float) --
The total of usage.
estimatedMonthlyCost (float) --
The estimated monthly cost of Amazon Inspector.
currency (string) --
The currency type used when calculating usage data.
cloudProvider (string) --
The cloud provider associated with the usage information.
{'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}}
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(
scanType='NETWORK'|'PACKAGE'|'CODE',
resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites'
)
string
[REQUIRED]
The scan type the key encrypts.
string
[REQUIRED]
The resource type the key encrypts.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountId': 'string',
'updateConfigurationInheritance': {'ec2Configuration': 'INHERIT_FROM_ADMIN',
'ecrConfiguration': 'INHERIT_FROM_ADMIN'}}
Updates the scan configuration for your Amazon Inspector account. If you don't specify an accountId, this operation updates the delegated administrator's configuration and propagates it to member accounts that have not been individually configured. If you specify an accountId, this operation updates that member account's configuration. Only the delegated administrator can specify an accountId; member accounts cannot call this operation.
See also: AWS API Documentation
Request Syntax
client.update_configuration(
accountId='string',
ecrConfiguration={
'rescanDuration': 'LIFETIME'|'DAYS_30'|'DAYS_180'|'DAYS_14'|'DAYS_60'|'DAYS_90',
'pullDateRescanDuration': 'DAYS_14'|'DAYS_30'|'DAYS_60'|'DAYS_90'|'DAYS_180',
'pullDateRescanMode': 'LAST_PULL_DATE'|'LAST_IN_USE_AT'
},
ec2Configuration={
'scanMode': 'EC2_SSM_AGENT_BASED'|'EC2_HYBRID',
'activateVMScanner': True|False
},
updateConfigurationInheritance={
'ec2Configuration': 'INHERIT_FROM_ADMIN',
'ecrConfiguration': 'INHERIT_FROM_ADMIN'
}
)
string
The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to update. When specified, you must be the delegated administrator for this member account. If not specified, the operation updates your own configuration and propagates changes to any member accounts that have not been individually configured.
dict
Specifies how the ECR automated re-scan will be updated for your environment.
rescanDuration (string) -- [REQUIRED]
The rescan duration configured for image push date.
pullDateRescanDuration (string) --
The rescan duration configured for image pull date.
pullDateRescanMode (string) --
The pull date for the re-scan mode.
dict
Specifies how the Amazon EC2 automated scan will be updated for your environment.
scanMode (string) -- [REQUIRED]
The scan method that is applied to the instance.
activateVMScanner (boolean) --
Whether to activate Amazon Inspector VM scanner for Amazon EC2 scanning.
dict
Specifies which scan-type configurations to reset to the delegated administrator's inherited values for the targeted member account. Each member of this structure is independently optional. When specified, ec2Configuration and ecrConfiguration must be absent, and accountId must also be present. Only INHERIT_FROM_ADMIN is valid for each member. If not specified, the operation uses the ec2Configuration and ecrConfiguration parameters instead.
ec2Configuration (string) --
The inheritance mode for Amazon EC2 scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account's Amazon EC2 scan configuration to inherit from the delegated administrator. If omitted, the member account's existing Amazon EC2 scan configuration is not changed.
ecrConfiguration (string) --
The inheritance mode for Amazon ECR scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account's Amazon ECR scan configuration to inherit from the delegated administrator. If omitted, the member account's existing Amazon ECR scan configuration is not changed.
dict
Response Syntax
{}
Response Structure
(dict) --
{'resourceType': {'Microsoft.Compute/virtualMachines',
'Microsoft.ContainerRegistry/registry/containerImage',
'Microsoft.Web/sites'}}
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',
scanType='NETWORK'|'PACKAGE'|'CODE',
resourceType='AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION'|'CODE_REPOSITORY'|'Microsoft.Compute/virtualMachines'|'Microsoft.ContainerRegistry/registry/containerImage'|'Microsoft.Web/sites'
)
string
[REQUIRED]
A KMS key ID for the encryption key.
string
[REQUIRED]
The scan type for the encryption key.
string
[REQUIRED]
The resource type for the encryption key.
dict
Response Syntax
{}
Response Structure
(dict) --
{'filterCriteria': {'cloudImageArchitecture': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudImageDigest': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageInUseCount': [{'lowerInclusive': 'double',
'upperInclusive': 'double'}],
'cloudImageLastInUseAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImagePushedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudImageRegistry': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageRepositoryName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudImageTags': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProvider': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderAccountId': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudProviderOrgId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudProviderRegion': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionExecutionRole': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionLastModifiedAt': [{'endInclusive': 'timestamp',
'startInclusive': 'timestamp'}],
'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
'PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
'| '
'PREFIX '
'| '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmImageReference': [{'comparison': 'EQUALS | PREFIX '
'| NOT_EQUALS',
'value': 'string'}],
'cloudVmNetworkId': [{'comparison': 'EQUALS | PREFIX | '
'NOT_EQUALS',
'value': 'string'}],
'cloudVmSubnetIds': [{'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',
filterCriteria={
'findingArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'awsAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'findingType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'severity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'firstObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lastObservedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'updatedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'findingStatus': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'title': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'inspectorScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'resourceType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'resourceTags': [
{
'comparison': 'EQUALS',
'key': 'string',
'value': 'string'
},
],
'ec2InstanceImageId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceVpcId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ec2InstanceSubnetId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageHash': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'ecrImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'ecrImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'portRange': [
{
'beginInclusive': 123,
'endInclusive': 123
},
],
'networkProtocol': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'componentType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilityId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerabilitySource': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vendorSeverity': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'vulnerablePackages': [
{
'name': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'version': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'epoch': {
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
'release': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'architecture': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLayerHash': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'sourceLambdaLayerArn': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
'filePath': {
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
}
},
],
'relatedVulnerabilities': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'fixAvailable': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLayers': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'lambdaFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'lambdaFunctionExecutionRoleArn': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'exploitAvailable': [
{
'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'
},
],
'epssScore': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'codeRepositoryProjectName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'codeRepositoryProviderType': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProvider': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderRegion': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderAccountId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudProviderOrgId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmImageReference': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmNetworkId': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudVmSubnetIds': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRepositoryName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageRegistry': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageDigest': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageTags': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImagePushedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageArchitecture': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudImageLastInUseAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudImageInUseCount': [
{
'upperInclusive': 123.0,
'lowerInclusive': 123.0
},
],
'cloudServerlessFunctionName': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionRuntime': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
],
'cloudServerlessFunctionLastModifiedAt': [
{
'startInclusive': datetime(2015, 1, 1),
'endInclusive': datetime(2015, 1, 1)
},
],
'cloudServerlessFunctionExecutionRole': [
{
'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
'value': 'string'
},
]
},
name='string',
filterArn='string',
reason='string'
)
string
Specifies the action that is to be applied to the findings that match the filter.
string
A description of the filter.
dict
Defines the criteria to be update in the filter.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
inspectorScore (list) --
The Amazon Inspector score to filter on.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included 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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered 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.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
vulnerablePackages (list) --
Details on the vulnerable packages used to filter findings.
(dict) --
Contains information on the details of a package filter.
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.
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.
epoch (dict) --
An object that contains details on the package epoch to filter on.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
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.
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.
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.
epssScore (list) --
The EPSS score used to filter findings.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
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.
cloudProvider (list) --
Filter criteria for the cloud provider.
(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.
cloudProviderRegion (list) --
Filter criteria for the cloud provider region.
(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.
cloudProviderAccountId (list) --
Filter criteria for the cloud provider account ID.
(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.
cloudProviderOrgId (list) --
Filter criteria for the cloud provider organization ID.
(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.
cloudVmImageReference (list) --
Filter criteria for the image reference of a VM instance.
(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.
cloudVmNetworkId (list) --
Filter criteria for the network ID of a VM instance.
(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.
cloudVmSubnetIds (list) --
Filter criteria for the subnet IDs of a VM instance.
(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.
cloudImageRepositoryName (list) --
Filter criteria for the repository name of a 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.
cloudImageRegistry (list) --
Filter criteria for the registry of a 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.
cloudImageDigest (list) --
Filter criteria for the digest of a 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.
cloudImageTags (list) --
Filter criteria for the tags of a 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.
cloudImagePushedAt (list) --
Filter criteria for when a container image was pushed.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageArchitecture (list) --
Filter criteria for the architecture of a 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.
cloudImageLastInUseAt (list) --
Filter criteria for the last time a container image was in use.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudImageInUseCount (list) --
Filter criteria for the in-use count of a container image.
(dict) --
An object that describes the details of a number filter.
upperInclusive (float) --
The highest number to be included in the filter.
lowerInclusive (float) --
The lowest number to be included in the filter.
cloudServerlessFunctionName (list) --
Filter criteria for the name of a serverless 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.
cloudServerlessFunctionRuntime (list) --
Filter criteria for the runtime of a serverless 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.
cloudServerlessFunctionLastModifiedAt (list) --
Filter criteria for when a serverless function was last modified.
(dict) --
Contains details on the time range used to filter findings.
startInclusive (datetime) --
A timestamp representing the start of the time period filtered on.
endInclusive (datetime) --
A timestamp representing the end of the time period filtered on.
cloudServerlessFunctionExecutionRole (list) --
Filter criteria for the execution role of a serverless 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.
string
The name of the filter.
string
[REQUIRED]
The Amazon Resource Number (ARN) of the filter to update.
string
The reason the filter was updated.
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Number (ARN) of the successfully updated filter.