AddAttributesToFindings

$result = $client->addAttributesToFindings([/* ... */]);
$promise = $client->addAttributesToFindingsAsync([/* ... */]);

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

Parameter Syntax

$result = $client->addAttributesToFindings([
    'attributes' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'findingArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Add attributes to findings

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

$result = $client->addAttributesToFindings([
    'attributes' => [
        [
            'key' => 'Example',
            'value' => 'example',
        ],
    ],
    'findingArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU',
    ],
]);

Result syntax:

[
    'failedItems' => [
    ],
]

CreateAssessmentTarget

$result = $client->createAssessmentTarget([/* ... */]);
$promise = $client->createAssessmentTargetAsync([/* ... */]);

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

Parameter Syntax

$result = $client->createAssessmentTarget([
    'assessmentTargetName' => '<string>', // REQUIRED
    'resourceGroupArn' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

InvalidCrossAccountRoleException:

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Create assessment target

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account.

$result = $client->createAssessmentTarget([
    'assessmentTargetName' => 'ExampleAssessmentTarget',
    'resourceGroupArn' => 'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv',
]);

Result syntax:

[
    'assessmentTargetArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX',
]

CreateAssessmentTemplate

$result = $client->createAssessmentTemplate([/* ... */]);
$promise = $client->createAssessmentTemplateAsync([/* ... */]);

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

Parameter Syntax

$result = $client->createAssessmentTemplate([
    'assessmentTargetArn' => '<string>', // REQUIRED
    'assessmentTemplateName' => '<string>', // REQUIRED
    'durationInSeconds' => <integer>, // REQUIRED
    'rulesPackageArns' => ['<string>', ...], // REQUIRED
    'userAttributesForFindings' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Create assessment template

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.

$result = $client->createAssessmentTemplate([
    'assessmentTargetArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX',
    'assessmentTemplateName' => 'ExampleAssessmentTemplate',
    'durationInSeconds' => 180,
    'rulesPackageArns' => [
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp',
    ],
    'userAttributesForFindings' => [
        [
            'key' => 'Example',
            'value' => 'example',
        ],
    ],
]);

Result syntax:

[
    'assessmentTemplateArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T',
]

CreateExclusionsPreview

$result = $client->createExclusionsPreview([/* ... */]);
$promise = $client->createExclusionsPreviewAsync([/* ... */]);

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

PreviewGenerationInProgressException:

The request is rejected. The specified assessment template is currently generating an exclusions preview.

InternalException:

Internal server error.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

CreateResourceGroup

$result = $client->createResourceGroup([/* ... */]);
$promise = $client->createResourceGroupAsync([/* ... */]);

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

Parameter Syntax

$result = $client->createResourceGroup([
    'resourceGroupTags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

AccessDeniedException:

You do not have required permissions to access the requested resource.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Create resource group

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target.

$result = $client->createResourceGroup([
    'resourceGroupTags' => [
        [
            'key' => 'Name',
            'value' => 'example',
        ],
    ],
]);

Result syntax:

[
    'resourceGroupArn' => 'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv',
]

DeleteAssessmentRun

$result = $client->deleteAssessmentRun([/* ... */]);
$promise = $client->deleteAssessmentRunAsync([/* ... */]);

Deletes the assessment run that is specified by the ARN of the assessment run.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AssessmentRunInProgressException:

You cannot perform a specified action if an assessment run is currently in progress.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Delete assessment run

Deletes the assessment run that is specified by the ARN of the assessment run.

$result = $client->deleteAssessmentRun([
    'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe',
]);

DeleteAssessmentTarget

$result = $client->deleteAssessmentTarget([/* ... */]);
$promise = $client->deleteAssessmentTargetAsync([/* ... */]);

Deletes the assessment target that is specified by the ARN of the assessment target.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AssessmentRunInProgressException:

You cannot perform a specified action if an assessment run is currently in progress.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Delete assessment target

Deletes the assessment target that is specified by the ARN of the assessment target.

$result = $client->deleteAssessmentTarget([
    'assessmentTargetArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
]);

DeleteAssessmentTemplate

$result = $client->deleteAssessmentTemplate([/* ... */]);
$promise = $client->deleteAssessmentTemplateAsync([/* ... */]);

Deletes the assessment template that is specified by the ARN of the assessment template.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AssessmentRunInProgressException:

You cannot perform a specified action if an assessment run is currently in progress.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Delete assessment template

Deletes the assessment template that is specified by the ARN of the assessment template.

$result = $client->deleteAssessmentTemplate([
    'assessmentTemplateArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T',
]);

DescribeAssessmentRuns

$result = $client->describeAssessmentRuns([/* ... */]);
$promise = $client->describeAssessmentRunsAsync([/* ... */]);

Describes the assessment runs that are specified by the ARNs of the assessment runs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assessmentRuns' => [
        [
            'arn' => '<string>',
            'assessmentTemplateArn' => '<string>',
            'completedAt' => <DateTime>,
            'createdAt' => <DateTime>,
            'dataCollected' => true || false,
            'durationInSeconds' => <integer>,
            'findingCounts' => [<integer>, ...],
            'name' => '<string>',
            'notifications' => [
                [
                    'date' => <DateTime>,
                    'error' => true || false,
                    'event' => 'ASSESSMENT_RUN_STARTED|ASSESSMENT_RUN_COMPLETED|ASSESSMENT_RUN_STATE_CHANGED|FINDING_REPORTED|OTHER',
                    'message' => '<string>',
                    'snsPublishStatusCode' => 'SUCCESS|TOPIC_DOES_NOT_EXIST|ACCESS_DENIED|INTERNAL_ERROR',
                    'snsTopicArn' => '<string>',
                ],
                // ...
            ],
            'rulesPackageArns' => ['<string>', ...],
            'startedAt' => <DateTime>,
            'state' => 'CREATED|START_DATA_COLLECTION_PENDING|START_DATA_COLLECTION_IN_PROGRESS|COLLECTING_DATA|STOP_DATA_COLLECTION_PENDING|DATA_COLLECTED|START_EVALUATING_RULES_PENDING|EVALUATING_RULES|FAILED|ERROR|COMPLETED|COMPLETED_WITH_ERRORS|CANCELED',
            'stateChangedAt' => <DateTime>,
            'stateChanges' => [
                [
                    'state' => 'CREATED|START_DATA_COLLECTION_PENDING|START_DATA_COLLECTION_IN_PROGRESS|COLLECTING_DATA|STOP_DATA_COLLECTION_PENDING|DATA_COLLECTED|START_EVALUATING_RULES_PENDING|EVALUATING_RULES|FAILED|ERROR|COMPLETED|COMPLETED_WITH_ERRORS|CANCELED',
                    'stateChangedAt' => <DateTime>,
                ],
                // ...
            ],
            'userAttributesForFindings' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describte assessment runs

Describes the assessment runs that are specified by the ARNs of the assessment runs.

$result = $client->describeAssessmentRuns([
    'assessmentRunArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
    ],
]);

Result syntax:

[
    'assessmentRuns' => [
        [
            'name' => 'Run 1 for ExampleAssessmentTemplate',
            'arn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
            'assessmentTemplateArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
            'completedAt' => ,
            'createdAt' => ,
            'dataCollected' => 1,
            'durationInSeconds' => 3600,
            'findingCounts' => [
                'High' => 14,
                'Informational' => 0,
                'Low' => 0,
                'Medium' => 2,
                'Undefined' => 0,
            ],
            'notifications' => [
            ],
            'rulesPackageArns' => [
                'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP',
            ],
            'startedAt' => ,
            'state' => 'COMPLETED',
            'stateChangedAt' => ,
            'stateChanges' => [
                [
                    'state' => 'CREATED',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'START_DATA_COLLECTION_PENDING',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'START_DATA_COLLECTION_IN_PROGRESS',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'COLLECTING_DATA',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'STOP_DATA_COLLECTION_PENDING',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'DATA_COLLECTED',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'EVALUATING_RULES',
                    'stateChangedAt' => ,
                ],
                [
                    'state' => 'COMPLETED',
                    'stateChangedAt' => ,
                ],
            ],
            'userAttributesForFindings' => [
            ],
        ],
    ],
    'failedItems' => [
    ],
]

DescribeAssessmentTargets

$result = $client->describeAssessmentTargets([/* ... */]);
$promise = $client->describeAssessmentTargetsAsync([/* ... */]);

Describes the assessment targets that are specified by the ARNs of the assessment targets.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assessmentTargets' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'resourceGroupArn' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describte assessment targets

Describes the assessment targets that are specified by the ARNs of the assessment targets.

$result = $client->describeAssessmentTargets([
    'assessmentTargetArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
    ],
]);

Result syntax:

[
    'assessmentTargets' => [
        [
            'name' => 'ExampleAssessmentTarget',
            'arn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
            'createdAt' => ,
            'resourceGroupArn' => 'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI',
            'updatedAt' => ,
        ],
    ],
    'failedItems' => [
    ],
]

DescribeAssessmentTemplates

$result = $client->describeAssessmentTemplates([/* ... */]);
$promise = $client->describeAssessmentTemplatesAsync([/* ... */]);

Describes the assessment templates that are specified by the ARNs of the assessment templates.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assessmentTemplates' => [
        [
            'arn' => '<string>',
            'assessmentRunCount' => <integer>,
            'assessmentTargetArn' => '<string>',
            'createdAt' => <DateTime>,
            'durationInSeconds' => <integer>,
            'lastAssessmentRunArn' => '<string>',
            'name' => '<string>',
            'rulesPackageArns' => ['<string>', ...],
            'userAttributesForFindings' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describte assessment templates

Describes the assessment templates that are specified by the ARNs of the assessment templates.

$result = $client->describeAssessmentTemplates([
    'assessmentTemplateArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
    ],
]);

Result syntax:

[
    'assessmentTemplates' => [
        [
            'name' => 'ExampleAssessmentTemplate',
            'arn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
            'assessmentRunCount' => 0,
            'assessmentTargetArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
            'createdAt' => ,
            'durationInSeconds' => 3600,
            'rulesPackageArns' => [
                'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP',
            ],
            'userAttributesForFindings' => [
            ],
        ],
    ],
    'failedItems' => [
    ],
]

DescribeCrossAccountAccessRole

$result = $client->describeCrossAccountAccessRole([/* ... */]);
$promise = $client->describeCrossAccountAccessRoleAsync([/* ... */]);

Describes the IAM role that enables Amazon Inspector to access your AWS account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'registeredAt' => <DateTime>,
    'roleArn' => '<string>',
    'valid' => true || false,
]

Result Details

Errors

InternalException:

Internal server error.

Examples

Example 1: Describte cross account access role

Describes the IAM role that enables Amazon Inspector to access your AWS account.

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

Result syntax:

[
    'registeredAt' => ,
    'roleArn' => 'arn:aws:iam::123456789012:role/inspector',
    'valid' => 1,
]

DescribeExclusions

$result = $client->describeExclusions([/* ... */]);
$promise = $client->describeExclusionsAsync([/* ... */]);

Describes the exclusions that are specified by the exclusions' ARNs.

Parameter Syntax

$result = $client->describeExclusions([
    'exclusionArns' => ['<string>', ...], // REQUIRED
    'locale' => 'EN_US',
]);

Parameter Details

Result Syntax

[
    'exclusions' => [
        '<Arn>' => [
            'arn' => '<string>',
            'attributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'description' => '<string>',
            'recommendation' => '<string>',
            'scopes' => [
                [
                    'key' => 'INSTANCE_ID|RULES_PACKAGE_ARN',
                    'value' => '<string>',
                ],
                // ...
            ],
            'title' => '<string>',
        ],
        // ...
    ],
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

DescribeFindings

$result = $client->describeFindings([/* ... */]);
$promise = $client->describeFindingsAsync([/* ... */]);

Describes the findings that are specified by the ARNs of the findings.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
    'findings' => [
        [
            'arn' => '<string>',
            'assetAttributes' => [
                'agentId' => '<string>',
                'amiId' => '<string>',
                'autoScalingGroup' => '<string>',
                'hostname' => '<string>',
                'ipv4Addresses' => ['<string>', ...],
                'networkInterfaces' => [
                    [
                        'ipv6Addresses' => ['<string>', ...],
                        'networkInterfaceId' => '<string>',
                        'privateDnsName' => '<string>',
                        'privateIpAddress' => '<string>',
                        'privateIpAddresses' => [
                            [
                                'privateDnsName' => '<string>',
                                'privateIpAddress' => '<string>',
                            ],
                            // ...
                        ],
                        'publicDnsName' => '<string>',
                        'publicIp' => '<string>',
                        'securityGroups' => [
                            [
                                'groupId' => '<string>',
                                'groupName' => '<string>',
                            ],
                            // ...
                        ],
                        'subnetId' => '<string>',
                        'vpcId' => '<string>',
                    ],
                    // ...
                ],
                'schemaVersion' => <integer>,
                'tags' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'assetType' => 'ec2-instance',
            'attributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'confidence' => <integer>,
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'indicatorOfCompromise' => true || false,
            'numericSeverity' => <float>,
            'recommendation' => '<string>',
            'schemaVersion' => <integer>,
            'service' => '<string>',
            'serviceAttributes' => [
                'assessmentRunArn' => '<string>',
                'rulesPackageArn' => '<string>',
                'schemaVersion' => <integer>,
            ],
            'severity' => 'Low|Medium|High|Informational|Undefined',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'userAttributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describe findings

Describes the findings that are specified by the ARNs of the findings.

$result = $client->describeFindings([
    'findingArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4',
    ],
]);

Result syntax:

[
    'failedItems' => [
    ],
    'findings' => [
        [
            'arn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4',
            'assetAttributes' => [
                'ipv4Addresses' => [
                ],
                'schemaVersion' => 1,
            ],
            'assetType' => 'ec2-instance',
            'attributes' => [
            ],
            'confidence' => 10,
            'createdAt' => ,
            'description' => 'Amazon Inspector did not find any potential security issues during this assessment.',
            'indicatorOfCompromise' => ,
            'numericSeverity' => 0,
            'recommendation' => 'No remediation needed.',
            'schemaVersion' => 1,
            'service' => 'Inspector',
            'serviceAttributes' => [
                'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
                'rulesPackageArn' => 'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP',
                'schemaVersion' => 1,
            ],
            'severity' => 'Informational',
            'title' => 'No potential security issues found',
            'updatedAt' => ,
            'userAttributes' => [
            ],
        ],
    ],
]

DescribeResourceGroups

$result = $client->describeResourceGroups([/* ... */]);
$promise = $client->describeResourceGroupsAsync([/* ... */]);

Describes the resource groups that are specified by the ARNs of the resource groups.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
    'resourceGroups' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describe resource groups

Describes the resource groups that are specified by the ARNs of the resource groups.

$result = $client->describeResourceGroups([
    'resourceGroupArns' => [
        'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI',
    ],
]);

Result syntax:

[
    'failedItems' => [
    ],
    'resourceGroups' => [
        [
            'arn' => 'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI',
            'createdAt' => ,
            'tags' => [
                [
                    'key' => 'Name',
                    'value' => 'example',
                ],
            ],
        ],
    ],
]

DescribeRulesPackages

$result = $client->describeRulesPackages([/* ... */]);
$promise = $client->describeRulesPackagesAsync([/* ... */]);

Describes the rules packages that are specified by the ARNs of the rules packages.

Parameter Syntax

$result = $client->describeRulesPackages([
    'locale' => 'EN_US',
    'rulesPackageArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
    'rulesPackages' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'provider' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Examples

Example 1: Describe rules packages

Describes the rules packages that are specified by the ARNs of the rules packages.

$result = $client->describeRulesPackages([
    'rulesPackageArns' => [
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ',
    ],
]);

Result syntax:

[
    'failedItems' => [
    ],
    'rulesPackages' => [
        [
            'version' => '1.1',
            'name' => 'Security Best Practices',
            'arn' => 'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ',
            'description' => 'The rules in this package help determine whether your systems are configured securely.',
            'provider' => 'Amazon Web Services, Inc.',
        ],
    ],
]

GetAssessmentReport

$result = $client->getAssessmentReport([/* ... */]);
$promise = $client->getAssessmentReportAsync([/* ... */]);

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

Parameter Syntax

$result = $client->getAssessmentReport([
    'assessmentRunArn' => '<string>', // REQUIRED
    'reportFileFormat' => 'HTML|PDF', // REQUIRED
    'reportType' => 'FINDING|FULL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'WORK_IN_PROGRESS|FAILED|COMPLETED',
    'url' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

AssessmentRunInProgressException:

You cannot perform a specified action if an assessment run is currently in progress.

UnsupportedFeatureException:

Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector became available.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

GetExclusionsPreview

$result = $client->getExclusionsPreview([/* ... */]);
$promise = $client->getExclusionsPreviewAsync([/* ... */]);

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Parameter Syntax

$result = $client->getExclusionsPreview([
    'assessmentTemplateArn' => '<string>', // REQUIRED
    'locale' => 'EN_US',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'previewToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'exclusionPreviews' => [
        [
            'attributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'description' => '<string>',
            'recommendation' => '<string>',
            'scopes' => [
                [
                    'key' => 'INSTANCE_ID|RULES_PACKAGE_ARN',
                    'value' => '<string>',
                ],
                // ...
            ],
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'previewStatus' => 'WORK_IN_PROGRESS|COMPLETED',
]

Result Details

Errors

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

InternalException:

Internal server error.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

GetTelemetryMetadata

$result = $client->getTelemetryMetadata([/* ... */]);
$promise = $client->getTelemetryMetadataAsync([/* ... */]);

Information about the data that is collected for the specified assessment run.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'telemetryMetadata' => [
        [
            'count' => <integer>,
            'dataSize' => <integer>,
            'messageType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: Get telemetry metadata

Information about the data that is collected for the specified assessment run.

$result = $client->getTelemetryMetadata([
    'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
]);

Result syntax:

[
    'telemetryMetadata' => [
        [
            'count' => 2,
            'dataSize' => 345,
            'messageType' => 'InspectorDuplicateProcess',
        ],
        [
            'count' => 3,
            'dataSize' => 255,
            'messageType' => 'InspectorTimeEventMsg',
        ],
        [
            'count' => 4,
            'dataSize' => 1082,
            'messageType' => 'InspectorNetworkInterface',
        ],
        [
            'count' => 2,
            'dataSize' => 349,
            'messageType' => 'InspectorDnsEntry',
        ],
        [
            'count' => 11,
            'dataSize' => 2514,
            'messageType' => 'InspectorDirectoryInfoMsg',
        ],
        [
            'count' => 1,
            'dataSize' => 179,
            'messageType' => 'InspectorTcpV6ListeningPort',
        ],
        [
            'count' => 101,
            'dataSize' => 10949,
            'messageType' => 'InspectorTerminal',
        ],
        [
            'count' => 26,
            'dataSize' => 5916,
            'messageType' => 'InspectorUser',
        ],
        [
            'count' => 282,
            'dataSize' => 32148,
            'messageType' => 'InspectorDynamicallyLoadedCodeModule',
        ],
        [
            'count' => 18,
            'dataSize' => 10172,
            'messageType' => 'InspectorCreateProcess',
        ],
        [
            'count' => 3,
            'dataSize' => 8001,
            'messageType' => 'InspectorProcessPerformance',
        ],
        [
            'count' => 1,
            'dataSize' => 360,
            'messageType' => 'InspectorOperatingSystem',
        ],
        [
            'count' => 6,
            'dataSize' => 546,
            'messageType' => 'InspectorStopProcess',
        ],
        [
            'count' => 1,
            'dataSize' => 1553,
            'messageType' => 'InspectorInstanceMetaData',
        ],
        [
            'count' => 2,
            'dataSize' => 434,
            'messageType' => 'InspectorTcpV4Connection',
        ],
        [
            'count' => 474,
            'dataSize' => 2960322,
            'messageType' => 'InspectorPackageInfo',
        ],
        [
            'count' => 3,
            'dataSize' => 2235,
            'messageType' => 'InspectorSystemPerformance',
        ],
        [
            'count' => 105,
            'dataSize' => 46048,
            'messageType' => 'InspectorCodeModule',
        ],
        [
            'count' => 1,
            'dataSize' => 182,
            'messageType' => 'InspectorUdpV6ListeningPort',
        ],
        [
            'count' => 2,
            'dataSize' => 371,
            'messageType' => 'InspectorUdpV4ListeningPort',
        ],
        [
            'count' => 18,
            'dataSize' => 8362,
            'messageType' => 'InspectorKernelModule',
        ],
        [
            'count' => 29,
            'dataSize' => 48788,
            'messageType' => 'InspectorConfigurationInfo',
        ],
        [
            'count' => 1,
            'dataSize' => 79,
            'messageType' => 'InspectorMonitoringStart',
        ],
        [
            'count' => 5,
            'dataSize' => 0,
            'messageType' => 'InspectorSplitMsgBegin',
        ],
        [
            'count' => 51,
            'dataSize' => 4593,
            'messageType' => 'InspectorGroup',
        ],
        [
            'count' => 1,
            'dataSize' => 184,
            'messageType' => 'InspectorTcpV4ListeningPort',
        ],
        [
            'count' => 1159,
            'dataSize' => 3146579,
            'messageType' => 'Total',
        ],
        [
            'count' => 5,
            'dataSize' => 0,
            'messageType' => 'InspectorSplitMsgEnd',
        ],
        [
            'count' => 1,
            'dataSize' => 612,
            'messageType' => 'InspectorLoadImageInProcess',
        ],
    ],
]

ListAssessmentRunAgents

$result = $client->listAssessmentRunAgents([/* ... */]);
$promise = $client->listAssessmentRunAgentsAsync([/* ... */]);

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

Parameter Syntax

$result = $client->listAssessmentRunAgents([
    'assessmentRunArn' => '<string>', // REQUIRED
    'filter' => [
        'agentHealthCodes' => ['<string>', ...], // REQUIRED
        'agentHealths' => ['<string>', ...], // REQUIRED
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentRunAgents' => [
        [
            'agentHealth' => 'HEALTHY|UNHEALTHY|UNKNOWN',
            'agentHealthCode' => 'IDLE|RUNNING|SHUTDOWN|UNHEALTHY|THROTTLED|UNKNOWN',
            'agentHealthDetails' => '<string>',
            'agentId' => '<string>',
            'assessmentRunArn' => '<string>',
            'autoScalingGroup' => '<string>',
            'telemetryMetadata' => [
                [
                    'count' => <integer>,
                    'dataSize' => <integer>,
                    'messageType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List assessment run agents

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

$result = $client->listAssessmentRunAgents([
    'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
    'maxResults' => 123,
]);

Result syntax:

[
    'assessmentRunAgents' => [
        [
            'agentHealth' => 'HEALTHY',
            'agentHealthCode' => 'RUNNING',
            'agentId' => 'i-49113b93',
            'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
            'telemetryMetadata' => [
                [
                    'count' => 2,
                    'dataSize' => 345,
                    'messageType' => 'InspectorDuplicateProcess',
                ],
                [
                    'count' => 3,
                    'dataSize' => 255,
                    'messageType' => 'InspectorTimeEventMsg',
                ],
                [
                    'count' => 4,
                    'dataSize' => 1082,
                    'messageType' => 'InspectorNetworkInterface',
                ],
                [
                    'count' => 2,
                    'dataSize' => 349,
                    'messageType' => 'InspectorDnsEntry',
                ],
                [
                    'count' => 11,
                    'dataSize' => 2514,
                    'messageType' => 'InspectorDirectoryInfoMsg',
                ],
                [
                    'count' => 1,
                    'dataSize' => 179,
                    'messageType' => 'InspectorTcpV6ListeningPort',
                ],
                [
                    'count' => 101,
                    'dataSize' => 10949,
                    'messageType' => 'InspectorTerminal',
                ],
                [
                    'count' => 26,
                    'dataSize' => 5916,
                    'messageType' => 'InspectorUser',
                ],
                [
                    'count' => 282,
                    'dataSize' => 32148,
                    'messageType' => 'InspectorDynamicallyLoadedCodeModule',
                ],
                [
                    'count' => 18,
                    'dataSize' => 10172,
                    'messageType' => 'InspectorCreateProcess',
                ],
                [
                    'count' => 3,
                    'dataSize' => 8001,
                    'messageType' => 'InspectorProcessPerformance',
                ],
                [
                    'count' => 1,
                    'dataSize' => 360,
                    'messageType' => 'InspectorOperatingSystem',
                ],
                [
                    'count' => 6,
                    'dataSize' => 546,
                    'messageType' => 'InspectorStopProcess',
                ],
                [
                    'count' => 1,
                    'dataSize' => 1553,
                    'messageType' => 'InspectorInstanceMetaData',
                ],
                [
                    'count' => 2,
                    'dataSize' => 434,
                    'messageType' => 'InspectorTcpV4Connection',
                ],
                [
                    'count' => 474,
                    'dataSize' => 2960322,
                    'messageType' => 'InspectorPackageInfo',
                ],
                [
                    'count' => 3,
                    'dataSize' => 2235,
                    'messageType' => 'InspectorSystemPerformance',
                ],
                [
                    'count' => 105,
                    'dataSize' => 46048,
                    'messageType' => 'InspectorCodeModule',
                ],
                [
                    'count' => 1,
                    'dataSize' => 182,
                    'messageType' => 'InspectorUdpV6ListeningPort',
                ],
                [
                    'count' => 2,
                    'dataSize' => 371,
                    'messageType' => 'InspectorUdpV4ListeningPort',
                ],
                [
                    'count' => 18,
                    'dataSize' => 8362,
                    'messageType' => 'InspectorKernelModule',
                ],
                [
                    'count' => 29,
                    'dataSize' => 48788,
                    'messageType' => 'InspectorConfigurationInfo',
                ],
                [
                    'count' => 1,
                    'dataSize' => 79,
                    'messageType' => 'InspectorMonitoringStart',
                ],
                [
                    'count' => 5,
                    'dataSize' => 0,
                    'messageType' => 'InspectorSplitMsgBegin',
                ],
                [
                    'count' => 51,
                    'dataSize' => 4593,
                    'messageType' => 'InspectorGroup',
                ],
                [
                    'count' => 1,
                    'dataSize' => 184,
                    'messageType' => 'InspectorTcpV4ListeningPort',
                ],
                [
                    'count' => 1159,
                    'dataSize' => 3146579,
                    'messageType' => 'Total',
                ],
                [
                    'count' => 5,
                    'dataSize' => 0,
                    'messageType' => 'InspectorSplitMsgEnd',
                ],
                [
                    'count' => 1,
                    'dataSize' => 612,
                    'messageType' => 'InspectorLoadImageInProcess',
                ],
            ],
        ],
    ],
    'nextToken' => '1',
]

ListAssessmentRuns

$result = $client->listAssessmentRuns([/* ... */]);
$promise = $client->listAssessmentRunsAsync([/* ... */]);

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

Parameter Syntax

$result = $client->listAssessmentRuns([
    'assessmentTemplateArns' => ['<string>', ...],
    'filter' => [
        'completionTimeRange' => [
            'beginDate' => <integer || string || DateTime>,
            'endDate' => <integer || string || DateTime>,
        ],
        'durationRange' => [
            'maxSeconds' => <integer>,
            'minSeconds' => <integer>,
        ],
        'namePattern' => '<string>',
        'rulesPackageArns' => ['<string>', ...],
        'startTimeRange' => [
            'beginDate' => <integer || string || DateTime>,
            'endDate' => <integer || string || DateTime>,
        ],
        'stateChangeTimeRange' => [
            'beginDate' => <integer || string || DateTime>,
            'endDate' => <integer || string || DateTime>,
        ],
        'states' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentRunArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List assessment runs

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

$result = $client->listAssessmentRuns([
    'assessmentTemplateArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
    ],
    'maxResults' => 123,
]);

Result syntax:

[
    'assessmentRunArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v',
    ],
    'nextToken' => '1',
]

ListAssessmentTargets

$result = $client->listAssessmentTargets([/* ... */]);
$promise = $client->listAssessmentTargetsAsync([/* ... */]);

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assessmentTargetArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

Examples

Example 1: List assessment targets

Lists the ARNs of the assessment targets within this AWS account.

$result = $client->listAssessmentTargets([
    'maxResults' => 123,
]);

Result syntax:

[
    'assessmentTargetArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
    ],
    'nextToken' => '1',
]

ListAssessmentTemplates

$result = $client->listAssessmentTemplates([/* ... */]);
$promise = $client->listAssessmentTemplatesAsync([/* ... */]);

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

Parameter Syntax

$result = $client->listAssessmentTemplates([
    'assessmentTargetArns' => ['<string>', ...],
    'filter' => [
        'durationRange' => [
            'maxSeconds' => <integer>,
            'minSeconds' => <integer>,
        ],
        'namePattern' => '<string>',
        'rulesPackageArns' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentTemplateArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List assessment templates

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

$result = $client->listAssessmentTemplates([
    'assessmentTargetArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
    ],
    'maxResults' => 123,
]);

Result syntax:

[
    'assessmentTemplateArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh',
    ],
    'nextToken' => '1',
]

ListEventSubscriptions

$result = $client->listEventSubscriptions([/* ... */]);
$promise = $client->listEventSubscriptionsAsync([/* ... */]);

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'subscriptions' => [
        [
            'eventSubscriptions' => [
                [
                    'event' => 'ASSESSMENT_RUN_STARTED|ASSESSMENT_RUN_COMPLETED|ASSESSMENT_RUN_STATE_CHANGED|FINDING_REPORTED|OTHER',
                    'subscribedAt' => <DateTime>,
                ],
                // ...
            ],
            'resourceArn' => '<string>',
            'topicArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List event subscriptions

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.

$result = $client->listEventSubscriptions([
    'maxResults' => 123,
    'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0',
]);

Result syntax:

[
    'nextToken' => '1',
    'subscriptions' => [
        [
            'eventSubscriptions' => [
                [
                    'event' => 'ASSESSMENT_RUN_COMPLETED',
                    'subscribedAt' => ,
                ],
            ],
            'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0',
            'topicArn' => 'arn:aws:sns:us-west-2:123456789012:exampletopic',
        ],
    ],
]

ListExclusions

$result = $client->listExclusions([/* ... */]);
$promise = $client->listExclusionsAsync([/* ... */]);

List exclusions that are generated by the assessment run.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'exclusionArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ListFindings

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

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

Parameter Syntax

$result = $client->listFindings([
    'assessmentRunArns' => ['<string>', ...],
    'filter' => [
        'agentIds' => ['<string>', ...],
        'attributes' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'autoScalingGroups' => ['<string>', ...],
        'creationTimeRange' => [
            'beginDate' => <integer || string || DateTime>,
            'endDate' => <integer || string || DateTime>,
        ],
        'ruleNames' => ['<string>', ...],
        'rulesPackageArns' => ['<string>', ...],
        'severities' => ['<string>', ...],
        'userAttributes' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'findingArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List findings

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

$result = $client->listFindings([
    'assessmentRunArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE',
    ],
    'maxResults' => 123,
]);

Result syntax:

[
    'findingArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4',
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy',
    ],
    'nextToken' => '1',
]

ListRulesPackages

$result = $client->listRulesPackages([/* ... */]);
$promise = $client->listRulesPackagesAsync([/* ... */]);

Lists all available Amazon Inspector rules packages.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'rulesPackageArns' => ['<string>', ...],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

Examples

Example 1: List rules packages

Lists all available Amazon Inspector rules packages.

$result = $client->listRulesPackages([
    'maxResults' => 123,
]);

Result syntax:

[
    'nextToken' => '1',
    'rulesPackageArns' => [
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p',
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc',
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ',
        'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD',
    ],
]

ListTagsForResource

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

Lists all tags associated with an assessment template.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Examples

Example 1: List tags for resource

Lists all tags associated with an assessment template.

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu',
]);

Result syntax:

[
    'tags' => [
        [
            'key' => 'Name',
            'value' => 'Example',
        ],
    ],
]

PreviewAgents

$result = $client->previewAgents([/* ... */]);
$promise = $client->previewAgentsAsync([/* ... */]);

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentPreviews' => [
        [
            'agentHealth' => 'HEALTHY|UNHEALTHY|UNKNOWN',
            'agentId' => '<string>',
            'agentVersion' => '<string>',
            'autoScalingGroup' => '<string>',
            'hostname' => '<string>',
            'ipv4Address' => '<string>',
            'kernelVersion' => '<string>',
            'operatingSystem' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

InvalidCrossAccountRoleException:

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

Examples

Example 1: Preview agents

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

$result = $client->previewAgents([
    'maxResults' => 123,
    'previewAgentsArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
]);

Result syntax:

[
    'agentPreviews' => [
        [
            'agentId' => 'i-49113b93',
        ],
    ],
    'nextToken' => '1',
]

RegisterCrossAccountAccessRole

$result = $client->registerCrossAccountAccessRole([/* ... */]);
$promise = $client->registerCrossAccountAccessRoleAsync([/* ... */]);

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

InvalidCrossAccountRoleException:

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Register cross account access role

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.

$result = $client->registerCrossAccountAccessRole([
    'roleArn' => 'arn:aws:iam::123456789012:role/inspector',
]);

RemoveAttributesFromFindings

$result = $client->removeAttributesFromFindings([/* ... */]);
$promise = $client->removeAttributesFromFindingsAsync([/* ... */]);

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'failedItems' => [
        '<Arn>' => [
            'failureCode' => 'INVALID_ARN|DUPLICATE_ARN|ITEM_DOES_NOT_EXIST|ACCESS_DENIED|LIMIT_EXCEEDED|INTERNAL_ERROR',
            'retryable' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Remove attributes from findings

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

$result = $client->removeAttributesFromFindings([
    'attributeKeys' => [
        'key=Example,value=example',
    ],
    'findingArns' => [
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU',
    ],
]);

Result syntax:

[
    'failedItems' => [
    ],
]

SetTagsForResource

$result = $client->setTagsForResource([/* ... */]);
$promise = $client->setTagsForResourceAsync([/* ... */]);

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Set tags for resource

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

$result = $client->setTagsForResource([
    'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0',
    'tags' => [
        [
            'key' => 'Example',
            'value' => 'example',
        ],
    ],
]);

StartAssessmentRun

$result = $client->startAssessmentRun([/* ... */]);
$promise = $client->startAssessmentRunAsync([/* ... */]);

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Parameter Syntax

$result = $client->startAssessmentRun([
    'assessmentRunName' => '<string>',
    'assessmentTemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

InvalidCrossAccountRoleException:

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

AgentsAlreadyRunningAssessmentException:

You started an assessment run, but one of the instances is already participating in another assessment run.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Start assessment run

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

$result = $client->startAssessmentRun([
    'assessmentRunName' => 'examplerun',
    'assessmentTemplateArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T',
]);

Result syntax:

[
    'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY',
]

StopAssessmentRun

$result = $client->stopAssessmentRun([/* ... */]);
$promise = $client->stopAssessmentRunAsync([/* ... */]);

Stops the assessment run that is specified by the ARN of the assessment run.

Parameter Syntax

$result = $client->stopAssessmentRun([
    'assessmentRunArn' => '<string>', // REQUIRED
    'stopAction' => 'START_EVALUATION|SKIP_EVALUATION',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Stop assessment run

Stops the assessment run that is specified by the ARN of the assessment run.

$result = $client->stopAssessmentRun([
    'assessmentRunArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe',
]);

SubscribeToEvent

$result = $client->subscribeToEvent([/* ... */]);
$promise = $client->subscribeToEventAsync([/* ... */]);

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

Parameter Syntax

$result = $client->subscribeToEvent([
    'event' => 'ASSESSMENT_RUN_STARTED|ASSESSMENT_RUN_COMPLETED|ASSESSMENT_RUN_STATE_CHANGED|FINDING_REPORTED|OTHER', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
    'topicArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Subscribe to event

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

$result = $client->subscribeToEvent([
    'event' => 'ASSESSMENT_RUN_COMPLETED',
    'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0',
    'topicArn' => 'arn:aws:sns:us-west-2:123456789012:exampletopic',
]);

UnsubscribeFromEvent

$result = $client->unsubscribeFromEvent([/* ... */]);
$promise = $client->unsubscribeFromEventAsync([/* ... */]);

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

Parameter Syntax

$result = $client->unsubscribeFromEvent([
    'event' => 'ASSESSMENT_RUN_STARTED|ASSESSMENT_RUN_COMPLETED|ASSESSMENT_RUN_STATE_CHANGED|FINDING_REPORTED|OTHER', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
    'topicArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Unsubscribe from event

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

$result = $client->unsubscribeFromEvent([
    'event' => 'ASSESSMENT_RUN_COMPLETED',
    'resourceArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0',
    'topicArn' => 'arn:aws:sns:us-west-2:123456789012:exampletopic',
]);

UpdateAssessmentTarget

$result = $client->updateAssessmentTarget([/* ... */]);
$promise = $client->updateAssessmentTargetAsync([/* ... */]);

Updates the assessment target that is specified by the ARN of the assessment target.

If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Parameter Syntax

$result = $client->updateAssessmentTarget([
    'assessmentTargetArn' => '<string>', // REQUIRED
    'assessmentTargetName' => '<string>', // REQUIRED
    'resourceGroupArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

AccessDeniedException:

You do not have required permissions to access the requested resource.

NoSuchEntityException:

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

ServiceTemporarilyUnavailableException:

The serice is temporary unavailable.

Examples

Example 1: Update assessment target

Updates the assessment target that is specified by the ARN of the assessment target.

$result = $client->updateAssessmentTarget([
    'assessmentTargetArn' => 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX',
    'assessmentTargetName' => 'Example',
    'resourceGroupArn' => 'arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt',
]);