AssociateMember

$result = $client->associateMember([/* ... */]);
$promise = $client->associateMemberAsync([/* ... */]);

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.

Parameter Syntax

$result = $client->associateMember([
    'accountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchAssociateCodeSecurityScanConfiguration

$result = $client->batchAssociateCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->batchAssociateCodeSecurityScanConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchAssociateCodeSecurityScanConfiguration([
    'associateConfigurationRequests' => [ // REQUIRED
        [
            'resource' => [ // REQUIRED
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failedAssociations' => [
        [
            'resource' => [
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>',
            'statusCode' => 'INTERNAL_ERROR|ACCESS_DENIED|SCAN_CONFIGURATION_NOT_FOUND|INVALID_INPUT|RESOURCE_NOT_FOUND|QUOTA_EXCEEDED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'successfulAssociations' => [
        [
            'resource' => [
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchDisassociateCodeSecurityScanConfiguration

$result = $client->batchDisassociateCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->batchDisassociateCodeSecurityScanConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDisassociateCodeSecurityScanConfiguration([
    'disassociateConfigurationRequests' => [ // REQUIRED
        [
            'resource' => [ // REQUIRED
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failedAssociations' => [
        [
            'resource' => [
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>',
            'statusCode' => 'INTERNAL_ERROR|ACCESS_DENIED|SCAN_CONFIGURATION_NOT_FOUND|INVALID_INPUT|RESOURCE_NOT_FOUND|QUOTA_EXCEEDED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'successfulAssociations' => [
        [
            'resource' => [
                'projectId' => '<string>',
            ],
            'scanConfigurationArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchGetAccountStatus

$result = $client->batchGetAccountStatus([/* ... */]);
$promise = $client->batchGetAccountStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetAccountStatus([
    'accountIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchGetCodeSnippet

$result = $client->batchGetCodeSnippet([/* ... */]);
$promise = $client->batchGetCodeSnippetAsync([/* ... */]);

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

Parameter Syntax

$result = $client->batchGetCodeSnippet([
    'findingArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeSnippetResults' => [
        [
            'codeSnippet' => [
                [
                    'content' => '<string>',
                    'lineNumber' => <integer>,
                ],
                // ...
            ],
            'endLine' => <integer>,
            'findingArn' => '<string>',
            'startLine' => <integer>,
            'suggestedFixes' => [
                [
                    'code' => '<string>',
                    'description' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'errors' => [
        [
            'errorCode' => 'INTERNAL_ERROR|ACCESS_DENIED|CODE_SNIPPET_NOT_FOUND|INVALID_INPUT',
            'errorMessage' => '<string>',
            'findingArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchGetFindingDetails

$result = $client->batchGetFindingDetails([/* ... */]);
$promise = $client->batchGetFindingDetailsAsync([/* ... */]);

Gets vulnerability details for findings.

Parameter Syntax

$result = $client->batchGetFindingDetails([
    'findingArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => 'INTERNAL_ERROR|ACCESS_DENIED|FINDING_DETAILS_NOT_FOUND|INVALID_INPUT',
            'errorMessage' => '<string>',
            'findingArn' => '<string>',
        ],
        // ...
    ],
    'findingDetails' => [
        [
            'cisaData' => [
                'action' => '<string>',
                'dateAdded' => <DateTime>,
                'dateDue' => <DateTime>,
            ],
            'cwes' => ['<string>', ...],
            'epssScore' => <float>,
            'evidences' => [
                [
                    'evidenceDetail' => '<string>',
                    'evidenceRule' => '<string>',
                    'severity' => '<string>',
                ],
                // ...
            ],
            'exploitObserved' => [
                'firstSeen' => <DateTime>,
                'lastSeen' => <DateTime>,
            ],
            'findingArn' => '<string>',
            'referenceUrls' => ['<string>', ...],
            'riskScore' => <integer>,
            'tools' => ['<string>', ...],
            'ttps' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample BatchGetFindingDetails Call

$result = $client->batchGetFindingDetails([
    'findingArns' => [
        'arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7',
        'arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7',
    ],
]);

Result syntax:

[
    'errors' => [
        [
            'errorCode' => 'ACCESS_DENIED',
            'errorMessage' => 'You don't have permission to access this finding',
            'findingArn' => 'arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7',
        ],
    ],
    'findingDetails' => [
        [
            'cisaData' => [
                'action' => 'For all affected software assets for which updates exist, the only acceptable remediation actions are: 1) Apply updates; OR 2) remove affected assets from agency networks.',
                'dateAdded' => ,
                'dateDue' => ,
            ],
            'cwes' => [
                'cwe-1234',
            ],
            'epssScore' => 0.85,
            'evidences' => [
                [
                    'evidenceDetail' => '2 sightings on 1 source',
                    'evidenceRule' => 'Historically Linked to Penetration Testing Tools',
                    'severity' => 'Low',
                ],
            ],
            'exploitObserved' => [
                'firstSeen' => ,
                'lastSeen' => ,
            ],
            'findingArn' => 'arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7',
            'referenceUrls' => [
                'https://nvd.nist.gov/vuln/detail/CVE-2019-20367',
            ],
            'riskScore' => 66,
            'tools' => [
                'Metasploit',
            ],
            'ttps' => [
                'TA0001',
                'TA0002',
            ],
        ],
    ],
]

BatchGetFreeTrialInfo

$result = $client->batchGetFreeTrialInfo([/* ... */]);
$promise = $client->batchGetFreeTrialInfoAsync([/* ... */]);

Gets free trial status for multiple Amazon Web Services accounts.

Parameter Syntax

$result = $client->batchGetFreeTrialInfo([
    'accountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accounts' => [
        [
            'accountId' => '<string>',
            'freeTrialInfo' => [
                [
                    'end' => <DateTime>,
                    'start' => <DateTime>,
                    'status' => 'ACTIVE|INACTIVE',
                    'type' => 'EC2|ECR|LAMBDA|LAMBDA_CODE|CODE_REPOSITORY',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'failedAccounts' => [
        [
            'accountId' => '<string>',
            'code' => 'ACCESS_DENIED|INTERNAL_ERROR',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchGetMemberEc2DeepInspectionStatus

$result = $client->batchGetMemberEc2DeepInspectionStatus([/* ... */]);
$promise = $client->batchGetMemberEc2DeepInspectionStatusAsync([/* ... */]);

Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

Parameter Syntax

$result = $client->batchGetMemberEc2DeepInspectionStatus([
    'accountIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accountIds' => [
        [
            'accountId' => '<string>',
            'errorMessage' => '<string>',
            'status' => 'ACTIVATED|DEACTIVATED|PENDING|FAILED',
        ],
        // ...
    ],
    'failedAccountIds' => [
        [
            'accountId' => '<string>',
            'ec2ScanStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|SUSPENDING|SUSPENDED',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

BatchUpdateMemberEc2DeepInspectionStatus

$result = $client->batchUpdateMemberEc2DeepInspectionStatus([/* ... */]);
$promise = $client->batchUpdateMemberEc2DeepInspectionStatusAsync([/* ... */]);

Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

Parameter Syntax

$result = $client->batchUpdateMemberEc2DeepInspectionStatus([
    'accountIds' => [ // REQUIRED
        [
            'accountId' => '<string>', // REQUIRED
            'activateDeepInspection' => true || false, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'accountIds' => [
        [
            'accountId' => '<string>',
            'errorMessage' => '<string>',
            'status' => 'ACTIVATED|DEACTIVATED|PENDING|FAILED',
        ],
        // ...
    ],
    'failedAccountIds' => [
        [
            'accountId' => '<string>',
            'ec2ScanStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|SUSPENDING|SUSPENDED',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CancelFindingsReport

$result = $client->cancelFindingsReport([/* ... */]);
$promise = $client->cancelFindingsReportAsync([/* ... */]);

Cancels the given findings report.

Parameter Syntax

$result = $client->cancelFindingsReport([
    'reportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'reportId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CancelSbomExport

$result = $client->cancelSbomExport([/* ... */]);
$promise = $client->cancelSbomExportAsync([/* ... */]);

Cancels a software bill of materials (SBOM) report.

Parameter Syntax

$result = $client->cancelSbomExport([
    'reportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'reportId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CreateCisScanConfiguration

$result = $client->createCisScanConfiguration([/* ... */]);
$promise = $client->createCisScanConfigurationAsync([/* ... */]);

Creates a CIS scan configuration.

Parameter Syntax

$result = $client->createCisScanConfiguration([
    'scanName' => '<string>', // REQUIRED
    'schedule' => [ // REQUIRED
        'daily' => [
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
        'monthly' => [
            'day' => 'SUN|MON|TUE|WED|THU|FRI|SAT', // REQUIRED
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
        'oneTime' => [
        ],
        'weekly' => [
            'days' => ['<string>', ...], // REQUIRED
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
    ],
    'securityLevel' => 'LEVEL_1|LEVEL_2', // REQUIRED
    'tags' => ['<string>', ...],
    'targets' => [ // REQUIRED
        'accountIds' => ['<string>', ...], // REQUIRED
        'targetResourceTags' => [ // REQUIRED
            '<TargetResourceTagsKey>' => ['<string>', ...],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample CreateCisScanConfiguration Call

$result = $client->createCisScanConfiguration([
    'scanName' => 'sample',
    'schedule' => [
        'daily' => [
            'startTime' => [
                'timeOfDay' => '12:34',
                'timezone' => 'UTC',
            ],
        ],
    ],
    'securityLevel' => 'LEVEL_1',
    'targets' => [
        'accountIds' => [
            'SELF',
        ],
        'targetResourceTags' => [
            'key' => [
                'value',
            ],
        ],
    ],
]);

Result syntax:

[
    'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
]

CreateCodeSecurityIntegration

$result = $client->createCodeSecurityIntegration([/* ... */]);
$promise = $client->createCodeSecurityIntegrationAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createCodeSecurityIntegration([
    'details' => [
        'gitlabSelfManaged' => [
            'accessToken' => '<string>', // REQUIRED
            'instanceUrl' => '<string>', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'GITLAB_SELF_MANAGED|GITHUB', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'authorizationUrl' => '<string>',
    'integrationArn' => '<string>',
    'status' => 'PENDING|IN_PROGRESS|ACTIVE|INACTIVE|DISABLING',
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CreateCodeSecurityScanConfiguration

$result = $client->createCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->createCodeSecurityScanConfigurationAsync([/* ... */]);

Creates a scan configuration for code security scanning.

Parameter Syntax

$result = $client->createCodeSecurityScanConfiguration([
    'configuration' => [ // REQUIRED
        'continuousIntegrationScanConfiguration' => [
            'supportedEvents' => ['<string>', ...], // REQUIRED
        ],
        'periodicScanConfiguration' => [
            'frequency' => 'WEEKLY|MONTHLY|NEVER',
            'frequencyExpression' => '<string>',
        ],
        'ruleSetCategories' => ['<string>', ...], // REQUIRED
    ],
    'level' => 'ORGANIZATION|ACCOUNT', // REQUIRED
    'name' => '<string>', // REQUIRED
    'scopeSettings' => [
        'projectSelectionScope' => 'ALL',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CreateFilter

$result = $client->createFilter([/* ... */]);
$promise = $client->createFilterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createFilter([
    'action' => 'NONE|SUPPRESS', // REQUIRED
    'description' => '<string>',
    'filterCriteria' => [ // REQUIRED
        'awsAccountId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProjectName' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProviderType' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeVulnerabilityDetectorName' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeVulnerabilityDetectorTags' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeVulnerabilityFilePath' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'componentId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'componentType' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceImageId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceSubnetId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceVpcId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrImageArchitecture' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrImageHash' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrImageInUseCount' => [
            [
                'lowerInclusive' => <float>,
                'upperInclusive' => <float>,
            ],
            // ...
        ],
        'ecrImageLastInUseAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'ecrImagePushedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'ecrImageRegistry' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrImageRepositoryName' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrImageTags' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'epssScore' => [
            [
                'lowerInclusive' => <float>,
                'upperInclusive' => <float>,
            ],
            // ...
        ],
        'exploitAvailable' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'findingArn' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'findingStatus' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'findingType' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'firstObservedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'fixAvailable' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'inspectorScore' => [
            [
                'lowerInclusive' => <float>,
                'upperInclusive' => <float>,
            ],
            // ...
        ],
        'lambdaFunctionExecutionRoleArn' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionLastModifiedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'lambdaFunctionLayers' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionName' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionRuntime' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lastObservedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'networkProtocol' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'portRange' => [
            [
                'beginInclusive' => <integer>,
                'endInclusive' => <integer>,
            ],
            // ...
        ],
        'relatedVulnerabilities' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceType' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'severity' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'title' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'updatedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'vendorSeverity' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'vulnerabilityId' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'vulnerabilitySource' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'vulnerablePackages' => [
            [
                'architecture' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'epoch' => [
                    'lowerInclusive' => <float>,
                    'upperInclusive' => <float>,
                ],
                'filePath' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'name' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'release' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'sourceLambdaLayerArn' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'sourceLayerHash' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'version' => [
                    'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'reason' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

BadRequestException:

One or more tags submitted as part of the request is not valid.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CreateFindingsReport

$result = $client->createFindingsReport([/* ... */]);
$promise = $client->createFindingsReportAsync([/* ... */]);

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'reportId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

CreateSbomExport

$result = $client->createSbomExport([/* ... */]);
$promise = $client->createSbomExportAsync([/* ... */]);

Creates a software bill of materials (SBOM) report.

Parameter Syntax

$result = $client->createSbomExport([
    'reportFormat' => 'CYCLONEDX_1_4|SPDX_2_3', // REQUIRED
    'resourceFilterCriteria' => [
        'accountId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'ecrImageTags' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrRepositoryName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    's3Destination' => [ // REQUIRED
        'bucketName' => '<string>', // REQUIRED
        'keyPrefix' => '<string>',
        'kmsKeyArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'reportId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DeleteCisScanConfiguration

$result = $client->deleteCisScanConfiguration([/* ... */]);
$promise = $client->deleteCisScanConfigurationAsync([/* ... */]);

Deletes a CIS scan configuration.

Parameter Syntax

$result = $client->deleteCisScanConfiguration([
    'scanConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample DeleteCisScanConfiguration Call

$result = $client->deleteCisScanConfiguration([
    'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
]);

Result syntax:

[
    'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
]

DeleteCodeSecurityIntegration

$result = $client->deleteCodeSecurityIntegration([/* ... */]);
$promise = $client->deleteCodeSecurityIntegrationAsync([/* ... */]);

Deletes a code security integration.

Parameter Syntax

$result = $client->deleteCodeSecurityIntegration([
    'integrationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'integrationArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DeleteCodeSecurityScanConfiguration

$result = $client->deleteCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->deleteCodeSecurityScanConfigurationAsync([/* ... */]);

Deletes a code security scan configuration.

Parameter Syntax

$result = $client->deleteCodeSecurityScanConfiguration([
    'scanConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DeleteFilter

$result = $client->deleteFilter([/* ... */]);
$promise = $client->deleteFilterAsync([/* ... */]);

Deletes a filter resource.

Parameter Syntax

$result = $client->deleteFilter([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DescribeOrganizationConfiguration

$result = $client->describeOrganizationConfiguration([/* ... */]);
$promise = $client->describeOrganizationConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeOrganizationConfiguration([
]);

Parameter Details

Result Syntax

[
    'autoEnable' => [
        'codeRepository' => true || false,
        'ec2' => true || false,
        'ecr' => true || false,
        'lambda' => true || false,
        'lambdaCode' => true || false,
    ],
    'maxAccountLimitReached' => true || false,
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Disable

$result = $client->disable([/* ... */]);
$promise = $client->disableAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disable([
    'accountIds' => ['<string>', ...],
    'resourceTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DisableDelegatedAdminAccount

$result = $client->disableDelegatedAdminAccount([/* ... */]);
$promise = $client->disableDelegatedAdminAccountAsync([/* ... */]);

Disables the Amazon Inspector delegated administrator for your organization.

Parameter Syntax

$result = $client->disableDelegatedAdminAccount([
    'delegatedAdminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'delegatedAdminAccountId' => '<string>',
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

DisassociateMember

$result = $client->disassociateMember([/* ... */]);
$promise = $client->disassociateMemberAsync([/* ... */]);

Disassociates a member account from an Amazon Inspector delegated administrator.

Parameter Syntax

$result = $client->disassociateMember([
    'accountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Enable

$result = $client->enable([/* ... */]);
$promise = $client->enableAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enable([
    'accountIds' => ['<string>', ...],
    'clientToken' => '<string>',
    'resourceTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

EnableDelegatedAdminAccount

$result = $client->enableDelegatedAdminAccount([/* ... */]);
$promise = $client->enableDelegatedAdminAccountAsync([/* ... */]);

Enables the Amazon Inspector delegated administrator for your Organizations organization.

Parameter Syntax

$result = $client->enableDelegatedAdminAccount([
    'clientToken' => '<string>',
    'delegatedAdminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'delegatedAdminAccountId' => '<string>',
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetCisScanReport

$result = $client->getCisScanReport([/* ... */]);
$promise = $client->getCisScanReportAsync([/* ... */]);

Retrieves a CIS scan report.

Parameter Syntax

$result = $client->getCisScanReport([
    'reportFormat' => 'PDF|CSV',
    'scanArn' => '<string>', // REQUIRED
    'targetAccounts' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'status' => 'SUCCEEDED|FAILED|IN_PROGRESS',
    'url' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample GetCisScanReport Call

$result = $client->getCisScanReport([
    'reportFormat' => 'PDF',
    'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
]);

Result syntax:

[
    'status' => 'SUCCEEDED',
    'url' => 'www.s3.amazon.com/abcdef',
]

GetCisScanResultDetails

$result = $client->getCisScanResultDetails([/* ... */]);
$promise = $client->getCisScanResultDetailsAsync([/* ... */]);

Retrieves CIS scan result details.

Parameter Syntax

$result = $client->getCisScanResultDetails([
    'accountId' => '<string>', // REQUIRED
    'filterCriteria' => [
        'checkIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'findingArnFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'findingStatusFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'PASSED|FAILED|SKIPPED', // REQUIRED
            ],
            // ...
        ],
        'securityLevelFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'LEVEL_1|LEVEL_2', // REQUIRED
            ],
            // ...
        ],
        'titleFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scanArn' => '<string>', // REQUIRED
    'sortBy' => 'CHECK_ID|STATUS',
    'sortOrder' => 'ASC|DESC',
    'targetResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scanResultDetails' => [
        [
            'accountId' => '<string>',
            'checkDescription' => '<string>',
            'checkId' => '<string>',
            'findingArn' => '<string>',
            'level' => 'LEVEL_1|LEVEL_2',
            'platform' => '<string>',
            'remediation' => '<string>',
            'scanArn' => '<string>',
            'status' => 'PASSED|FAILED|SKIPPED',
            'statusReason' => '<string>',
            'targetResourceId' => '<string>',
            'title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample GetCisScanResultDetails Call

$result = $client->getCisScanResultDetails([
    'accountId' => '123412341234',
    'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
    'targetResourceId' => 'i-12341234',
]);

Result syntax:

[
    'scanResultDetails' => [
        [
            'accountId' => '123412341234',
            'checkDescription' => 'description',
            'checkId' => '1.1.1.1',
            'level' => 'LEVEL_1',
            'platform' => 'AMAZON_LINUX_2',
            'remediation' => 'fix',
            'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
            'status' => 'PASSED',
            'targetResourceId' => 'i-12341234',
            'title' => 'title1',
        ],
    ],
]

GetClustersForImage

$result = $client->getClustersForImage([/* ... */]);
$promise = $client->getClustersForImageAsync([/* ... */]);

Returns a list of clusters and metadata associated with an image.

Parameter Syntax

$result = $client->getClustersForImage([
    'filter' => [ // REQUIRED
        'resourceId' => '<string>', // REQUIRED
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        [
            'clusterArn' => '<string>',
            'clusterDetails' => [
                [
                    'clusterMetadata' => [
                        'awsEcsMetadataDetails' => [
                            'detailsGroup' => '<string>',
                            'taskDefinitionArn' => '<string>',
                        ],
                        'awsEksMetadataDetails' => [
                            'namespace' => '<string>',
                            'workloadInfoList' => [
                                [
                                    'name' => '<string>',
                                    'type' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'lastInUse' => <DateTime>,
                    'runningUnitCount' => <integer>,
                    'stoppedUnitCount' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetCodeSecurityIntegration

$result = $client->getCodeSecurityIntegration([/* ... */]);
$promise = $client->getCodeSecurityIntegrationAsync([/* ... */]);

Retrieves information about a code security integration.

Parameter Syntax

$result = $client->getCodeSecurityIntegration([
    'integrationArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'authorizationUrl' => '<string>',
    'createdOn' => <DateTime>,
    'integrationArn' => '<string>',
    'lastUpdateOn' => <DateTime>,
    'name' => '<string>',
    'status' => 'PENDING|IN_PROGRESS|ACTIVE|INACTIVE|DISABLING',
    'statusReason' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'GITLAB_SELF_MANAGED|GITHUB',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetCodeSecurityScan

$result = $client->getCodeSecurityScan([/* ... */]);
$promise = $client->getCodeSecurityScanAsync([/* ... */]);

Retrieves information about a specific code security scan.

Parameter Syntax

$result = $client->getCodeSecurityScan([
    'resource' => [ // REQUIRED
        'projectId' => '<string>',
    ],
    'scanId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
    'createdAt' => <DateTime>,
    'lastCommitId' => '<string>',
    'resource' => [
        'projectId' => '<string>',
    ],
    'scanId' => '<string>',
    'status' => 'IN_PROGRESS|SUCCESSFUL|FAILED|SKIPPED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetCodeSecurityScanConfiguration

$result = $client->getCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->getCodeSecurityScanConfigurationAsync([/* ... */]);

Retrieves information about a code security scan configuration.

Parameter Syntax

$result = $client->getCodeSecurityScanConfiguration([
    'scanConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'continuousIntegrationScanConfiguration' => [
            'supportedEvents' => ['<string>', ...],
        ],
        'periodicScanConfiguration' => [
            'frequency' => 'WEEKLY|MONTHLY|NEVER',
            'frequencyExpression' => '<string>',
        ],
        'ruleSetCategories' => ['<string>', ...],
    ],
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'level' => 'ORGANIZATION|ACCOUNT',
    'name' => '<string>',
    'scanConfigurationArn' => '<string>',
    'scopeSettings' => [
        'projectSelectionScope' => 'ALL',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetConfiguration

$result = $client->getConfiguration([/* ... */]);
$promise = $client->getConfigurationAsync([/* ... */]);

Retrieves setting configurations for Inspector scans.

Parameter Syntax

$result = $client->getConfiguration([
]);

Parameter Details

Result Syntax

[
    'ec2Configuration' => [
        'scanModeState' => [
            'scanMode' => 'EC2_SSM_AGENT_BASED|EC2_HYBRID',
            'scanModeStatus' => 'SUCCESS|PENDING',
        ],
    ],
    'ecrConfiguration' => [
        'rescanDurationState' => [
            'pullDateRescanDuration' => 'DAYS_14|DAYS_30|DAYS_60|DAYS_90|DAYS_180',
            'pullDateRescanMode' => 'LAST_PULL_DATE|LAST_IN_USE_AT',
            'rescanDuration' => 'LIFETIME|DAYS_30|DAYS_180|DAYS_14|DAYS_60|DAYS_90',
            'status' => 'SUCCESS|PENDING|FAILED',
            'updatedAt' => <DateTime>,
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetDelegatedAdminAccount

$result = $client->getDelegatedAdminAccount([/* ... */]);
$promise = $client->getDelegatedAdminAccountAsync([/* ... */]);

Retrieves information about the Amazon Inspector delegated administrator for your organization.

Parameter Syntax

$result = $client->getDelegatedAdminAccount([
]);

Parameter Details

Result Syntax

[
    'delegatedAdmin' => [
        'accountId' => '<string>',
        'relationshipStatus' => 'CREATED|INVITED|DISABLED|ENABLED|REMOVED|RESIGNED|DELETED|EMAIL_VERIFICATION_IN_PROGRESS|EMAIL_VERIFICATION_FAILED|REGION_DISABLED|ACCOUNT_SUSPENDED|CANNOT_CREATE_DETECTOR_IN_ORG_MASTER',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetEc2DeepInspectionConfiguration

$result = $client->getEc2DeepInspectionConfiguration([/* ... */]);
$promise = $client->getEc2DeepInspectionConfigurationAsync([/* ... */]);

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

Parameter Syntax

$result = $client->getEc2DeepInspectionConfiguration([
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'orgPackagePaths' => ['<string>', ...],
    'packagePaths' => ['<string>', ...],
    'status' => 'ACTIVATED|DEACTIVATED|PENDING|FAILED',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetEncryptionKey

$result = $client->getEncryptionKey([/* ... */]);
$promise = $client->getEncryptionKeyAsync([/* ... */]);

Gets an encryption key.

Parameter Syntax

$result = $client->getEncryptionKey([
    'resourceType' => 'AWS_EC2_INSTANCE|AWS_ECR_CONTAINER_IMAGE|AWS_ECR_REPOSITORY|AWS_LAMBDA_FUNCTION|CODE_REPOSITORY', // REQUIRED
    'scanType' => 'NETWORK|PACKAGE|CODE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'kmsKeyId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetFindingsReportStatus

$result = $client->getFindingsReportStatus([/* ... */]);
$promise = $client->getFindingsReportStatusAsync([/* ... */]);

Gets the status of a findings report.

Parameter Syntax

$result = $client->getFindingsReportStatus([
    'reportId' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetMember

$result = $client->getMember([/* ... */]);
$promise = $client->getMemberAsync([/* ... */]);

Gets member information for your organization.

Parameter Syntax

$result = $client->getMember([
    'accountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'member' => [
        'accountId' => '<string>',
        'delegatedAdminAccountId' => '<string>',
        'relationshipStatus' => 'CREATED|INVITED|DISABLED|ENABLED|REMOVED|RESIGNED|DELETED|EMAIL_VERIFICATION_IN_PROGRESS|EMAIL_VERIFICATION_FAILED|REGION_DISABLED|ACCOUNT_SUSPENDED|CANNOT_CREATE_DETECTOR_IN_ORG_MASTER',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

GetSbomExport

$result = $client->getSbomExport([/* ... */]);
$promise = $client->getSbomExportAsync([/* ... */]);

Gets details of a software bill of materials (SBOM) report.

Parameter Syntax

$result = $client->getSbomExport([
    'reportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errorCode' => 'INTERNAL_ERROR|INVALID_PERMISSIONS|NO_FINDINGS_FOUND|BUCKET_NOT_FOUND|INCOMPATIBLE_BUCKET_REGION|MALFORMED_KMS_KEY',
    'errorMessage' => '<string>',
    'filterCriteria' => [
        'accountId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
        'ec2InstanceTags' => [
            [
                'comparison' => 'EQUALS',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'ecrImageTags' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
        'ecrRepositoryName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
        'lambdaFunctionName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
        'lambdaFunctionTags' => [
            [
                'comparison' => 'EQUALS',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
    'format' => 'CYCLONEDX_1_4|SPDX_2_3',
    'reportId' => '<string>',
    's3Destination' => [
        'bucketName' => '<string>',
        'keyPrefix' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'status' => 'SUCCEEDED|IN_PROGRESS|CANCELLED|FAILED',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListAccountPermissions

$result = $client->listAccountPermissions([/* ... */]);
$promise = $client->listAccountPermissionsAsync([/* ... */]);

Lists the permissions an account has to configure Amazon Inspector.

Parameter Syntax

$result = $client->listAccountPermissions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'service' => 'EC2|ECR|LAMBDA',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'operation' => 'ENABLE_SCANNING|DISABLE_SCANNING|ENABLE_REPOSITORY|DISABLE_REPOSITORY',
            'service' => 'EC2|ECR|LAMBDA',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListCisScanConfigurations

$result = $client->listCisScanConfigurations([/* ... */]);
$promise = $client->listCisScanConfigurationsAsync([/* ... */]);

Lists CIS scan configurations.

Parameter Syntax

$result = $client->listCisScanConfigurations([
    'filterCriteria' => [
        'scanConfigurationArnFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanNameFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetResourceTagFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'SCAN_NAME|SCAN_CONFIGURATION_ARN',
    'sortOrder' => 'ASC|DESC',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scanConfigurations' => [
        [
            'ownerId' => '<string>',
            'scanConfigurationArn' => '<string>',
            'scanName' => '<string>',
            'schedule' => [
                'daily' => [
                    'startTime' => [
                        'timeOfDay' => '<string>',
                        'timezone' => '<string>',
                    ],
                ],
                'monthly' => [
                    'day' => 'SUN|MON|TUE|WED|THU|FRI|SAT',
                    'startTime' => [
                        'timeOfDay' => '<string>',
                        'timezone' => '<string>',
                    ],
                ],
                'oneTime' => [
                ],
                'weekly' => [
                    'days' => ['<string>', ...],
                    'startTime' => [
                        'timeOfDay' => '<string>',
                        'timezone' => '<string>',
                    ],
                ],
            ],
            'securityLevel' => 'LEVEL_1|LEVEL_2',
            'tags' => ['<string>', ...],
            'targets' => [
                'accountIds' => ['<string>', ...],
                'targetResourceTags' => [
                    '<TargetResourceTagsKey>' => ['<string>', ...],
                    // ...
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample ListCisScanConfigurations Call

$result = $client->listCisScanConfigurations([
]);

Result syntax:

[
    'scanConfigurations' => [
        [
            'ownerId' => '123412341234',
            'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
            'scanName' => 'sample',
            'schedule' => [
                'daily' => [
                    'startTime' => [
                        'timeOfDay' => '12:34',
                        'timezone' => 'UTC',
                    ],
                ],
            ],
            'securityLevel' => 'LEVEL_1',
            'targets' => [
                'accountIds' => [
                    '123412341234',
                ],
                'targetResourceTags' => [
                    'key' => [
                        'value',
                    ],
                ],
            ],
        ],
    ],
]

ListCisScanResultsAggregatedByChecks

$result = $client->listCisScanResultsAggregatedByChecks([/* ... */]);
$promise = $client->listCisScanResultsAggregatedByChecksAsync([/* ... */]);

Lists scan results aggregated by checks.

Parameter Syntax

$result = $client->listCisScanResultsAggregatedByChecks([
    'filterCriteria' => [
        'accountIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'checkIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'failedResourcesFilters' => [
            [
                'lowerInclusive' => <integer>,
                'upperInclusive' => <integer>,
            ],
            // ...
        ],
        'platformFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'securityLevelFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'LEVEL_1|LEVEL_2', // REQUIRED
            ],
            // ...
        ],
        'titleFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scanArn' => '<string>', // REQUIRED
    'sortBy' => 'CHECK_ID|TITLE|PLATFORM|FAILED_COUNTS|SECURITY_LEVEL',
    'sortOrder' => 'ASC|DESC',
]);

Parameter Details

Result Syntax

[
    'checkAggregations' => [
        [
            'accountId' => '<string>',
            'checkDescription' => '<string>',
            'checkId' => '<string>',
            'level' => 'LEVEL_1|LEVEL_2',
            'platform' => '<string>',
            'scanArn' => '<string>',
            'statusCounts' => [
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
            ],
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample ListCisScanResultsAggregatedByChecks Call

$result = $client->listCisScanResultsAggregatedByChecks([
    'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
]);

Result syntax:

[
    'checkAggregations' => [
        [
            'accountId' => '123412341234',
            'checkDescription' => 'description',
            'checkId' => '1.1.1.1',
            'level' => 'LEVEL_1',
            'platform' => 'AMAZON_LINUX_2',
            'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
            'statusCounts' => [
                'failed' => 0,
                'passed' => 2,
                'skipped' => 1,
            ],
            'title' => 'title1',
        ],
    ],
]

ListCisScanResultsAggregatedByTargetResource

$result = $client->listCisScanResultsAggregatedByTargetResource([/* ... */]);
$promise = $client->listCisScanResultsAggregatedByTargetResourceAsync([/* ... */]);

Lists scan results aggregated by a target resource.

Parameter Syntax

$result = $client->listCisScanResultsAggregatedByTargetResource([
    'filterCriteria' => [
        'accountIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'checkIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'failedChecksFilters' => [
            [
                'lowerInclusive' => <integer>,
                'upperInclusive' => <integer>,
            ],
            // ...
        ],
        'platformFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'statusFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'PASSED|FAILED|SKIPPED', // REQUIRED
            ],
            // ...
        ],
        'targetResourceIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetResourceTagFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetStatusFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'TIMED_OUT|CANCELLED|COMPLETED', // REQUIRED
            ],
            // ...
        ],
        'targetStatusReasonFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'SCAN_IN_PROGRESS|UNSUPPORTED_OS|SSM_UNMANAGED', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scanArn' => '<string>', // REQUIRED
    'sortBy' => 'RESOURCE_ID|FAILED_COUNTS|ACCOUNT_ID|PLATFORM|TARGET_STATUS|TARGET_STATUS_REASON',
    'sortOrder' => 'ASC|DESC',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetResourceAggregations' => [
        [
            'accountId' => '<string>',
            'platform' => '<string>',
            'scanArn' => '<string>',
            'statusCounts' => [
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
            ],
            'targetResourceId' => '<string>',
            'targetResourceTags' => [
                '<TargetResourceTagsKey>' => ['<string>', ...],
                // ...
            ],
            'targetStatus' => 'TIMED_OUT|CANCELLED|COMPLETED',
            'targetStatusReason' => 'SCAN_IN_PROGRESS|UNSUPPORTED_OS|SSM_UNMANAGED',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample ListCisScanResultsAggregatedByTargetResource Call

$result = $client->listCisScanResultsAggregatedByTargetResource([
    'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
]);

Result syntax:

[
    'targetResourceAggregations' => [
        [
            'accountId' => '123412341234',
            'platform' => 'AMAZON_LINUX_2',
            'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
            'statusCounts' => [
                'failed' => 0,
                'passed' => 2,
                'skipped' => 1,
            ],
            'targetResourceId' => 'i-12341234',
            'targetResourceTags' => [
                'key' => [
                    'value',
                ],
            ],
            'targetStatus' => 'COMPLETED',
        ],
    ],
]

ListCisScans

$result = $client->listCisScans([/* ... */]);
$promise = $client->listCisScansAsync([/* ... */]);

Returns a CIS scan list.

Parameter Syntax

$result = $client->listCisScans([
    'detailLevel' => 'ORGANIZATION|MEMBER',
    'filterCriteria' => [
        'failedChecksFilters' => [
            [
                'lowerInclusive' => <integer>,
                'upperInclusive' => <integer>,
            ],
            // ...
        ],
        'scanArnFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanAtFilters' => [
            [
                'earliestScanStartTime' => <integer || string || DateTime>,
                'latestScanStartTime' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'scanConfigurationArnFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanNameFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanStatusFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'value' => 'FAILED|COMPLETED|CANCELLED|IN_PROGRESS', // REQUIRED
            ],
            // ...
        ],
        'scheduledByFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetAccountIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetResourceIdFilters' => [
            [
                'comparison' => 'EQUALS|PREFIX|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'targetResourceTagFilters' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'STATUS|SCHEDULED_BY|SCAN_START_DATE|FAILED_CHECKS',
    'sortOrder' => 'ASC|DESC',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scans' => [
        [
            'failedChecks' => <integer>,
            'scanArn' => '<string>',
            'scanConfigurationArn' => '<string>',
            'scanDate' => <DateTime>,
            'scanName' => '<string>',
            'scheduledBy' => '<string>',
            'securityLevel' => 'LEVEL_1|LEVEL_2',
            'status' => 'FAILED|COMPLETED|CANCELLED|IN_PROGRESS',
            'targets' => [
                'accountIds' => ['<string>', ...],
                'targetResourceTags' => [
                    '<TargetResourceTagsKey>' => ['<string>', ...],
                    // ...
                ],
            ],
            'totalChecks' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample ListCisScans Call

$result = $client->listCisScans([
]);

Result syntax:

[
    'scans' => [
        [
            'failedChecks' => 2,
            'scanArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38',
            'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
            'scanDate' => ,
            'scanName' => 'sample',
            'scheduledBy' => 'Delegated Admin',
            'securityLevel' => 'LEVEL_1',
            'status' => 'COMPLETED',
            'targets' => [
                'accountIds' => [
                    '123412341234',
                ],
                'targetResourceTags' => [
                    'key' => [
                        'value',
                    ],
                ],
            ],
            'totalChecks' => 150,
        ],
    ],
]

ListCodeSecurityIntegrations

$result = $client->listCodeSecurityIntegrations([/* ... */]);
$promise = $client->listCodeSecurityIntegrationsAsync([/* ... */]);

Lists all code security integrations in your account.

Parameter Syntax

$result = $client->listCodeSecurityIntegrations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'integrations' => [
        [
            'createdOn' => <DateTime>,
            'integrationArn' => '<string>',
            'lastUpdateOn' => <DateTime>,
            'name' => '<string>',
            'status' => 'PENDING|IN_PROGRESS|ACTIVE|INACTIVE|DISABLING',
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'GITLAB_SELF_MANAGED|GITHUB',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListCodeSecurityScanConfigurationAssociations

$result = $client->listCodeSecurityScanConfigurationAssociations([/* ... */]);
$promise = $client->listCodeSecurityScanConfigurationAssociationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCodeSecurityScanConfigurationAssociations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scanConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'associations' => [
        [
            'resource' => [
                'projectId' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListCodeSecurityScanConfigurations

$result = $client->listCodeSecurityScanConfigurations([/* ... */]);
$promise = $client->listCodeSecurityScanConfigurationsAsync([/* ... */]);

Lists all code security scan configurations in your account.

Parameter Syntax

$result = $client->listCodeSecurityScanConfigurations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configurations' => [
        [
            'continuousIntegrationScanSupportedEvents' => ['<string>', ...],
            'frequencyExpression' => '<string>',
            'name' => '<string>',
            'ownerAccountId' => '<string>',
            'periodicScanFrequency' => 'WEEKLY|MONTHLY|NEVER',
            'ruleSetCategories' => ['<string>', ...],
            'scanConfigurationArn' => '<string>',
            'scopeSettings' => [
                'projectSelectionScope' => 'ALL',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListCoverage

$result = $client->listCoverage([/* ... */]);
$promise = $client->listCoverageAsync([/* ... */]);

Lists coverage details for your environment.

Parameter Syntax

$result = $client->listCoverage([
    'filterCriteria' => [
        'accountId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProjectName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProviderType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProviderTypeVisibility' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'ecrImageInUseCount' => [
            [
                'lowerInclusive' => <integer>,
                'upperInclusive' => <integer>,
            ],
            // ...
        ],
        'ecrImageLastInUseAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'ecrImageTags' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrRepositoryName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'imagePulledAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'lambdaFunctionName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionRuntime' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'lastScannedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'lastScannedCommitId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanMode' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanStatusCode' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanStatusReason' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListCoverageStatistics

$result = $client->listCoverageStatistics([/* ... */]);
$promise = $client->listCoverageStatisticsAsync([/* ... */]);

Lists Amazon Inspector coverage statistics for your environment.

Parameter Syntax

$result = $client->listCoverageStatistics([
    'filterCriteria' => [
        'accountId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProjectName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProviderType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'codeRepositoryProviderTypeVisibility' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2InstanceTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'ecrImageInUseCount' => [
            [
                'lowerInclusive' => <integer>,
                'upperInclusive' => <integer>,
            ],
            // ...
        ],
        'ecrImageLastInUseAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'ecrImageTags' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ecrRepositoryName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'imagePulledAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'lambdaFunctionName' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionRuntime' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'lambdaFunctionTags' => [
            [
                'comparison' => 'EQUALS', // REQUIRED
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'lastScannedAt' => [
            [
                'endInclusive' => <integer || string || DateTime>,
                'startInclusive' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'lastScannedCommitId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceId' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'resourceType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanMode' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanStatusCode' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanStatusReason' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'scanType' => [
            [
                'comparison' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'groupBy' => 'SCAN_STATUS_CODE|SCAN_STATUS_REASON|ACCOUNT_ID|RESOURCE_TYPE|ECR_REPOSITORY_NAME',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'countsByGroup' => [
        [
            'count' => <integer>,
            'groupKey' => 'SCAN_STATUS_CODE|SCAN_STATUS_REASON|ACCOUNT_ID|RESOURCE_TYPE|ECR_REPOSITORY_NAME',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'totalCounts' => <integer>,
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListDelegatedAdminAccounts

$result = $client->listDelegatedAdminAccounts([/* ... */]);
$promise = $client->listDelegatedAdminAccountsAsync([/* ... */]);

Lists information about the Amazon Inspector delegated administrator of your organization.

Parameter Syntax

$result = $client->listDelegatedAdminAccounts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'delegatedAdminAccounts' => [
        [
            'accountId' => '<string>',
            'status' => 'ENABLED|DISABLE_IN_PROGRESS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListFilters

$result = $client->listFilters([/* ... */]);
$promise = $client->listFiltersAsync([/* ... */]);

Lists the filters associated with your account.

Parameter Syntax

$result = $client->listFilters([
    'action' => 'NONE|SUPPRESS',
    'arns' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListFindingAggregations

$result = $client->listFindingAggregations([/* ... */]);
$promise = $client->listFindingAggregationsAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListFindings

$result = $client->listFindings([/* ... */]);
$promise = $client->listFindingsAsync([/* ... */]);

Lists findings for your environment.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListMembers

$result = $client->listMembers([/* ... */]);
$promise = $client->listMembersAsync([/* ... */]);

List members associated with the Amazon Inspector delegated administrator for your organization.

Parameter Syntax

$result = $client->listMembers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'onlyAssociated' => true || false,
]);

Parameter Details

Result Syntax

[
    'members' => [
        [
            'accountId' => '<string>',
            'delegatedAdminAccountId' => '<string>',
            'relationshipStatus' => 'CREATED|INVITED|DISABLED|ENABLED|REMOVED|RESIGNED|DELETED|EMAIL_VERIFICATION_IN_PROGRESS|EMAIL_VERIFICATION_FAILED|REGION_DISABLED|ACCOUNT_SUSPENDED|CANNOT_CREATE_DETECTOR_IN_ORG_MASTER',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags attached to a given resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ListUsageTotals

$result = $client->listUsageTotals([/* ... */]);
$promise = $client->listUsageTotalsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listUsageTotals([
    'accountIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'totals' => [
        [
            'accountId' => '<string>',
            'usage' => [
                [
                    'currency' => 'USD',
                    'estimatedMonthlyCost' => <float>,
                    'total' => <float>,
                    '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',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

ResetEncryptionKey

$result = $client->resetEncryptionKey([/* ... */]);
$promise = $client->resetEncryptionKeyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->resetEncryptionKey([
    'resourceType' => 'AWS_EC2_INSTANCE|AWS_ECR_CONTAINER_IMAGE|AWS_ECR_REPOSITORY|AWS_LAMBDA_FUNCTION|CODE_REPOSITORY', // REQUIRED
    'scanType' => 'NETWORK|PACKAGE|CODE', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

SearchVulnerabilities

$result = $client->searchVulnerabilities([/* ... */]);
$promise = $client->searchVulnerabilitiesAsync([/* ... */]);

Lists Amazon Inspector coverage details for a specific vulnerability.

Parameter Syntax

$result = $client->searchVulnerabilities([
    'filterCriteria' => [ // REQUIRED
        'vulnerabilityIds' => ['<string>', ...], // REQUIRED
    ],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'vulnerabilities' => [
        [
            'atigData' => [
                'firstSeen' => <DateTime>,
                'lastSeen' => <DateTime>,
                'targets' => ['<string>', ...],
                'ttps' => ['<string>', ...],
            ],
            'cisaData' => [
                'action' => '<string>',
                'dateAdded' => <DateTime>,
                'dateDue' => <DateTime>,
            ],
            'cvss2' => [
                'baseScore' => <float>,
                'scoringVector' => '<string>',
            ],
            'cvss3' => [
                'baseScore' => <float>,
                'scoringVector' => '<string>',
            ],
            'cvss4' => [
                'baseScore' => <float>,
                'scoringVector' => '<string>',
            ],
            'cwes' => ['<string>', ...],
            'description' => '<string>',
            'detectionPlatforms' => ['<string>', ...],
            'epss' => [
                'score' => <float>,
            ],
            'exploitObserved' => [
                'firstSeen' => <DateTime>,
                'lastSeen' => <DateTime>,
            ],
            'id' => '<string>',
            'referenceUrls' => ['<string>', ...],
            'relatedVulnerabilities' => ['<string>', ...],
            'source' => 'NVD',
            'sourceUrl' => '<string>',
            'vendorCreatedAt' => <DateTime>,
            'vendorSeverity' => '<string>',
            'vendorUpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

SendCisSessionHealth

$result = $client->sendCisSessionHealth([/* ... */]);
$promise = $client->sendCisSessionHealthAsync([/* ... */]);

Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.

Parameter Syntax

$result = $client->sendCisSessionHealth([
    'scanJobId' => '<string>', // REQUIRED
    'sessionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample SendCisSessionHealth Call

$result = $client->sendCisSessionHealth([
    'scanJobId' => '624b746d-e080-44ae-8c1d-48e653365a38',
    'sessionToken' => '624b746d-e080-44ae-8c1d-48e653365a31',
]);

Result syntax:

[
]

SendCisSessionTelemetry

$result = $client->sendCisSessionTelemetry([/* ... */]);
$promise = $client->sendCisSessionTelemetryAsync([/* ... */]);

Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.

Parameter Syntax

$result = $client->sendCisSessionTelemetry([
    'messages' => [ // REQUIRED
        [
            'cisRuleDetails' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
            'ruleId' => '<string>', // REQUIRED
            'status' => 'FAILED|PASSED|NOT_EVALUATED|INFORMATIONAL|UNKNOWN|NOT_APPLICABLE|ERROR', // REQUIRED
        ],
        // ...
    ],
    'scanJobId' => '<string>', // REQUIRED
    'sessionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample SendCisSessionTelemetry Call

$result = $client->sendCisSessionTelemetry([
    'messages' => [
        [
            'cisRuleDetails' => <BLOB>,
            'ruleId' => '1.12.1',
            'status' => 'FAILED',
        ],
        [
            'cisRuleDetails' => <BLOB>,
            'ruleId' => '1.2.1',
            'status' => 'PASSED',
        ],
    ],
    'scanJobId' => '624b746d-e080-44ae-8c1d-48e653365a38',
    'sessionToken' => '624b746d-e080-44ae-8c1d-48e653365a31',
]);

Result syntax:

[
]

StartCisSession

$result = $client->startCisSession([/* ... */]);
$promise = $client->startCisSessionAsync([/* ... */]);

Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.

Parameter Syntax

$result = $client->startCisSession([
    'message' => [ // REQUIRED
        'sessionToken' => '<string>', // REQUIRED
    ],
    'scanJobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample SendCisSessionHealth Call

$result = $client->startCisSession([
    'message' => [
        'sessionToken' => '624b746d-e080-44ae-8c1d-48e653365a31',
    ],
    'scanJobId' => '624b746d-e080-44ae-8c1d-48e653365a38',
]);

Result syntax:

[
]

StartCodeSecurityScan

$result = $client->startCodeSecurityScan([/* ... */]);
$promise = $client->startCodeSecurityScanAsync([/* ... */]);

Initiates a code security scan on a specified repository.

Parameter Syntax

$result = $client->startCodeSecurityScan([
    'clientToken' => '<string>',
    'resource' => [ // REQUIRED
        'projectId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'scanId' => '<string>',
    'status' => 'IN_PROGRESS|SUCCESSFUL|FAILED|SKIPPED',
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

StopCisSession

$result = $client->stopCisSession([/* ... */]);
$promise = $client->stopCisSessionAsync([/* ... */]);

Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.

Parameter Syntax

$result = $client->stopCisSession([
    'message' => [ // REQUIRED
        'benchmarkProfile' => '<string>',
        'benchmarkVersion' => '<string>',
        'computePlatform' => [
            'product' => '<string>',
            'vendor' => '<string>',
            'version' => '<string>',
        ],
        'progress' => [ // REQUIRED
            'errorChecks' => <integer>,
            'failedChecks' => <integer>,
            'informationalChecks' => <integer>,
            'notApplicableChecks' => <integer>,
            'notEvaluatedChecks' => <integer>,
            'successfulChecks' => <integer>,
            'totalChecks' => <integer>,
            'unknownChecks' => <integer>,
        ],
        'reason' => '<string>',
        'status' => 'SUCCESS|FAILED|INTERRUPTED|UNSUPPORTED_OS', // REQUIRED
    ],
    'scanJobId' => '<string>', // REQUIRED
    'sessionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample StopCisSession Call

$result = $client->stopCisSession([
    'message' => [
        'benchmarkProfile' => 'xccdf_org.cisecurity.benchmarks_profile_Level_1',
        'benchmarkVersion' => '2.0.0',
        'computePlatform' => [
            'version' => '20.04',
            'product' => 'ubuntu',
            'vendor' => 'canonical',
        ],
        'progress' => [
            'errorChecks' => 1,
            'failedChecks' => 0,
            'informationalChecks' => 1,
            'notApplicableChecks' => 0,
            'notEvaluatedChecks' => 2,
            'successfulChecks' => 5,
            'totalChecks' => 10,
            'unknownChecks' => 0,
        ],
        'reason' => 'Failure Reason',
        'status' => 'FAILED',
    ],
    'scanJobId' => '624b746d-e080-44ae-8c1d-48e653365a38',
    'sessionToken' => '624b746d-e080-44ae-8c1d-48e653365a31',
]);

Result syntax:

[
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

One or more tags submitted as part of the request is not valid.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

UpdateCisScanConfiguration

$result = $client->updateCisScanConfiguration([/* ... */]);
$promise = $client->updateCisScanConfigurationAsync([/* ... */]);

Updates a CIS scan configuration.

Parameter Syntax

$result = $client->updateCisScanConfiguration([
    'scanConfigurationArn' => '<string>', // REQUIRED
    'scanName' => '<string>',
    'schedule' => [
        'daily' => [
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
        'monthly' => [
            'day' => 'SUN|MON|TUE|WED|THU|FRI|SAT', // REQUIRED
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
        'oneTime' => [
        ],
        'weekly' => [
            'days' => ['<string>', ...], // REQUIRED
            'startTime' => [ // REQUIRED
                'timeOfDay' => '<string>', // REQUIRED
                'timezone' => '<string>', // REQUIRED
            ],
        ],
    ],
    'securityLevel' => 'LEVEL_1|LEVEL_2',
    'targets' => [
        'accountIds' => ['<string>', ...],
        'targetResourceTags' => [
            '<TargetResourceTagsKey>' => ['<string>', ...],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

Examples

Example 1: Sample UpdateCisScanConfiguration Call

$result = $client->updateCisScanConfiguration([
    'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
    'scanName' => 'sample_new',
    'schedule' => [
        'daily' => [
            'startTime' => [
                'timeOfDay' => '12:56',
                'timezone' => 'UTC',
            ],
        ],
    ],
    'securityLevel' => 'LEVEL_2',
    'targets' => [
        'accountIds' => [
            'SELF',
        ],
        'targetResourceTags' => [
            'key2' => [
                'value2',
            ],
        ],
    ],
]);

Result syntax:

[
    'scanConfigurationArn' => 'arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38',
]

UpdateCodeSecurityIntegration

$result = $client->updateCodeSecurityIntegration([/* ... */]);
$promise = $client->updateCodeSecurityIntegrationAsync([/* ... */]);

Updates an existing code security integration.

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

Parameter Syntax

$result = $client->updateCodeSecurityIntegration([
    'details' => [ // REQUIRED
        'github' => [
            'code' => '<string>', // REQUIRED
            'installationId' => '<string>', // REQUIRED
        ],
        'gitlabSelfManaged' => [
            'authCode' => '<string>', // REQUIRED
        ],
    ],
    'integrationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'integrationArn' => '<string>',
    'status' => 'PENDING|IN_PROGRESS|ACTIVE|INACTIVE|DISABLING',
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

UpdateCodeSecurityScanConfiguration

$result = $client->updateCodeSecurityScanConfiguration([/* ... */]);
$promise = $client->updateCodeSecurityScanConfigurationAsync([/* ... */]);

Updates an existing code security scan configuration.

Parameter Syntax

$result = $client->updateCodeSecurityScanConfiguration([
    'configuration' => [ // REQUIRED
        'continuousIntegrationScanConfiguration' => [
            'supportedEvents' => ['<string>', ...], // REQUIRED
        ],
        'periodicScanConfiguration' => [
            'frequency' => 'WEEKLY|MONTHLY|NEVER',
            'frequencyExpression' => '<string>',
        ],
        'ruleSetCategories' => ['<string>', ...], // REQUIRED
    ],
    'scanConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scanConfigurationArn' => '<string>',
]

Result Details

Errors

ConflictException:

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

UpdateConfiguration

$result = $client->updateConfiguration([/* ... */]);
$promise = $client->updateConfigurationAsync([/* ... */]);

Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.

Parameter Syntax

$result = $client->updateConfiguration([
    'ec2Configuration' => [
        'scanMode' => 'EC2_SSM_AGENT_BASED|EC2_HYBRID', // REQUIRED
    ],
    'ecrConfiguration' => [
        'pullDateRescanDuration' => 'DAYS_14|DAYS_30|DAYS_60|DAYS_90|DAYS_180',
        'pullDateRescanMode' => 'LAST_PULL_DATE|LAST_IN_USE_AT',
        'rescanDuration' => 'LIFETIME|DAYS_30|DAYS_180|DAYS_14|DAYS_60|DAYS_90', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.

UpdateEc2DeepInspectionConfiguration

$result = $client->updateEc2DeepInspectionConfiguration([/* ... */]);
$promise = $client->updateEc2DeepInspectionConfigurationAsync([/* ... */]);

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

Parameter Syntax

$result = $client->updateEc2DeepInspectionConfiguration([
    'activateDeepInspection' => true || false,
    'packagePaths' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'orgPackagePaths' => ['<string>', ...],
    'packagePaths' => ['<string>', ...],
    'status' => 'ACTIVATED|DEACTIVATED|PENDING|FAILED',
]

Result Details

Errors

ValidationException:

The request has failed validation due to missing required fields or having invalid inputs.

AccessDeniedException:

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

The request has failed due to an internal failure of the Amazon Inspector service.