NAME
Paws::Inspector - Perl Interface to AWS Amazon Inspector
SYNOPSIS
use Paws;
my $obj = Paws->service('Inspector');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
DESCRIPTION
Amazon Inspector
Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html).
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16
METHODS
AddAttributesToFindings
- Attributes => ArrayRef[Paws::Inspector::Attribute]
- FindingArns => ArrayRef[Str|Undef]
Each argument is described in detail in: Paws::Inspector::AddAttributesToFindings
Returns: a Paws::Inspector::AddAttributesToFindingsResponse instance
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
CreateAssessmentTarget
Each argument is described in detail in: Paws::Inspector::CreateAssessmentTarget
Returns: a Paws::Inspector::CreateAssessmentTargetResponse instance
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 (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) 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 (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html).
CreateAssessmentTemplate
- AssessmentTargetArn => Str
- AssessmentTemplateName => Str
- DurationInSeconds => Int
- RulesPackageArns => ArrayRef[Str|Undef]
- [UserAttributesForFindings => ArrayRef[Paws::Inspector::Attribute]]
Each argument is described in detail in: Paws::Inspector::CreateAssessmentTemplate
Returns: a Paws::Inspector::CreateAssessmentTemplateResponse instance
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) 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.
CreateExclusionsPreview
Each argument is described in detail in: Paws::Inspector::CreateExclusionsPreview
Returns: a Paws::Inspector::CreateExclusionsPreviewResponse instance
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.
CreateResourceGroup
- ResourceGroupTags => ArrayRef[Paws::Inspector::ResourceGroupTag]
Each argument is described in detail in: Paws::Inspector::CreateResourceGroup
Returns: a Paws::Inspector::CreateResourceGroupResponse instance
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.
DeleteAssessmentRun
Each argument is described in detail in: Paws::Inspector::DeleteAssessmentRun
Returns: nothing
Deletes the assessment run that is specified by the ARN of the assessment run.
DeleteAssessmentTarget
Each argument is described in detail in: Paws::Inspector::DeleteAssessmentTarget
Returns: nothing
Deletes the assessment target that is specified by the ARN of the assessment target.
DeleteAssessmentTemplate
Each argument is described in detail in: Paws::Inspector::DeleteAssessmentTemplate
Returns: nothing
Deletes the assessment template that is specified by the ARN of the assessment template.
DescribeAssessmentRuns
Each argument is described in detail in: Paws::Inspector::DescribeAssessmentRuns
Returns: a Paws::Inspector::DescribeAssessmentRunsResponse instance
Describes the assessment runs that are specified by the ARNs of the assessment runs.
DescribeAssessmentTargets
Each argument is described in detail in: Paws::Inspector::DescribeAssessmentTargets
Returns: a Paws::Inspector::DescribeAssessmentTargetsResponse instance
Describes the assessment targets that are specified by the ARNs of the assessment targets.
DescribeAssessmentTemplates
Each argument is described in detail in: Paws::Inspector::DescribeAssessmentTemplates
Returns: a Paws::Inspector::DescribeAssessmentTemplatesResponse instance
Describes the assessment templates that are specified by the ARNs of the assessment templates.
DescribeCrossAccountAccessRole
Each argument is described in detail in: Paws::Inspector::DescribeCrossAccountAccessRole
Returns: a Paws::Inspector::DescribeCrossAccountAccessRoleResponse instance
Describes the IAM role that enables Amazon Inspector to access your AWS account.
DescribeExclusions
Each argument is described in detail in: Paws::Inspector::DescribeExclusions
Returns: a Paws::Inspector::DescribeExclusionsResponse instance
Describes the exclusions that are specified by the exclusions' ARNs.
DescribeFindings
Each argument is described in detail in: Paws::Inspector::DescribeFindings
Returns: a Paws::Inspector::DescribeFindingsResponse instance
Describes the findings that are specified by the ARNs of the findings.
DescribeResourceGroups
Each argument is described in detail in: Paws::Inspector::DescribeResourceGroups
Returns: a Paws::Inspector::DescribeResourceGroupsResponse instance
Describes the resource groups that are specified by the ARNs of the resource groups.
DescribeRulesPackages
Each argument is described in detail in: Paws::Inspector::DescribeRulesPackages
Returns: a Paws::Inspector::DescribeRulesPackagesResponse instance
Describes the rules packages that are specified by the ARNs of the rules packages.
GetAssessmentReport
Each argument is described in detail in: Paws::Inspector::GetAssessmentReport
Returns: a Paws::Inspector::GetAssessmentReportResponse instance
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
GetExclusionsPreview
- AssessmentTemplateArn => Str
- PreviewToken => Str
- [Locale => Str]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::GetExclusionsPreview
Returns: a Paws::Inspector::GetExclusionsPreviewResponse instance
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.
GetTelemetryMetadata
Each argument is described in detail in: Paws::Inspector::GetTelemetryMetadata
Returns: a Paws::Inspector::GetTelemetryMetadataResponse instance
Information about the data that is collected for the specified assessment run.
ListAssessmentRunAgents
- AssessmentRunArn => Str
- [Filter => Paws::Inspector::AgentFilter]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::ListAssessmentRunAgents
Returns: a Paws::Inspector::ListAssessmentRunAgentsResponse instance
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
ListAssessmentRuns
- [AssessmentTemplateArns => ArrayRef[Str|Undef]]
- [Filter => Paws::Inspector::AssessmentRunFilter]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::ListAssessmentRuns
Returns: a Paws::Inspector::ListAssessmentRunsResponse instance
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
ListAssessmentTargets
- [Filter => Paws::Inspector::AssessmentTargetFilter]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::ListAssessmentTargets
Returns: a Paws::Inspector::ListAssessmentTargetsResponse instance
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html).
ListAssessmentTemplates
- [AssessmentTargetArns => ArrayRef[Str|Undef]]
- [Filter => Paws::Inspector::AssessmentTemplateFilter]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::ListAssessmentTemplates
Returns: a Paws::Inspector::ListAssessmentTemplatesResponse instance
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
ListEventSubscriptions
Each argument is described in detail in: Paws::Inspector::ListEventSubscriptions
Returns: a Paws::Inspector::ListEventSubscriptionsResponse instance
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.
ListExclusions
Each argument is described in detail in: Paws::Inspector::ListExclusions
Returns: a Paws::Inspector::ListExclusionsResponse instance
List exclusions that are generated by the assessment run.
ListFindings
- [AssessmentRunArns => ArrayRef[Str|Undef]]
- [Filter => Paws::Inspector::FindingFilter]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Inspector::ListFindings
Returns: a Paws::Inspector::ListFindingsResponse instance
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
ListRulesPackages
Each argument is described in detail in: Paws::Inspector::ListRulesPackages
Returns: a Paws::Inspector::ListRulesPackagesResponse instance
Lists all available Amazon Inspector rules packages.
ListTagsForResource
Each argument is described in detail in: Paws::Inspector::ListTagsForResource
Returns: a Paws::Inspector::ListTagsForResourceResponse instance
Lists all tags associated with an assessment template.
PreviewAgents
Each argument is described in detail in: Paws::Inspector::PreviewAgents
Returns: a Paws::Inspector::PreviewAgentsResponse instance
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
RegisterCrossAccountAccessRole
Each argument is described in detail in: Paws::Inspector::RegisterCrossAccountAccessRole
Returns: nothing
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
RemoveAttributesFromFindings
Each argument is described in detail in: Paws::Inspector::RemoveAttributesFromFindings
Returns: a Paws::Inspector::RemoveAttributesFromFindingsResponse instance
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.
SetTagsForResource
- ResourceArn => Str
- [Tags => ArrayRef[Paws::Inspector::Tag]]
Each argument is described in detail in: Paws::Inspector::SetTagsForResource
Returns: nothing
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
StartAssessmentRun
Each argument is described in detail in: Paws::Inspector::StartAssessmentRun
Returns: a Paws::Inspector::StartAssessmentRunResponse instance
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.
StopAssessmentRun
Each argument is described in detail in: Paws::Inspector::StopAssessmentRun
Returns: nothing
Stops the assessment run that is specified by the ARN of the assessment run.
SubscribeToEvent
Each argument is described in detail in: Paws::Inspector::SubscribeToEvent
Returns: nothing
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
UnsubscribeFromEvent
Each argument is described in detail in: Paws::Inspector::UnsubscribeFromEvent
Returns: nothing
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
UpdateAssessmentTarget
Each argument is described in detail in: Paws::Inspector::UpdateAssessmentTarget
Returns: nothing
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.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllAssessmentRunAgents(sub { },AssessmentRunArn => Str, [Filter => Paws::Inspector::AgentFilter, MaxResults => Int, NextToken => Str])
ListAllAssessmentRunAgents(AssessmentRunArn => Str, [Filter => Paws::Inspector::AgentFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- assessmentRunAgents, passing the object as the first parameter, and the string 'assessmentRunAgents' as the second parameter
If not, it will return a a Paws::Inspector::ListAssessmentRunAgentsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAssessmentRuns(sub { },[AssessmentTemplateArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::AssessmentRunFilter, MaxResults => Int, NextToken => Str])
ListAllAssessmentRuns([AssessmentTemplateArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::AssessmentRunFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- assessmentRunArns, passing the object as the first parameter, and the string 'assessmentRunArns' as the second parameter
If not, it will return a a Paws::Inspector::ListAssessmentRunsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAssessmentTargets(sub { },[Filter => Paws::Inspector::AssessmentTargetFilter, MaxResults => Int, NextToken => Str])
ListAllAssessmentTargets([Filter => Paws::Inspector::AssessmentTargetFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- assessmentTargetArns, passing the object as the first parameter, and the string 'assessmentTargetArns' as the second parameter
If not, it will return a a Paws::Inspector::ListAssessmentTargetsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAssessmentTemplates(sub { },[AssessmentTargetArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::AssessmentTemplateFilter, MaxResults => Int, NextToken => Str])
ListAllAssessmentTemplates([AssessmentTargetArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::AssessmentTemplateFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- assessmentTemplateArns, passing the object as the first parameter, and the string 'assessmentTemplateArns' as the second parameter
If not, it will return a a Paws::Inspector::ListAssessmentTemplatesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllEventSubscriptions(sub { },[MaxResults => Int, NextToken => Str, ResourceArn => Str])
ListAllEventSubscriptions([MaxResults => Int, NextToken => Str, ResourceArn => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- subscriptions, passing the object as the first parameter, and the string 'subscriptions' as the second parameter
If not, it will return a a Paws::Inspector::ListEventSubscriptionsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllExclusions(sub { },AssessmentRunArn => Str, [MaxResults => Int, NextToken => Str])
ListAllExclusions(AssessmentRunArn => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- exclusionArns, passing the object as the first parameter, and the string 'exclusionArns' as the second parameter
If not, it will return a a Paws::Inspector::ListExclusionsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllFindings(sub { },[AssessmentRunArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::FindingFilter, MaxResults => Int, NextToken => Str])
ListAllFindings([AssessmentRunArns => ArrayRef[Str|Undef], Filter => Paws::Inspector::FindingFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- findingArns, passing the object as the first parameter, and the string 'findingArns' as the second parameter
If not, it will return a a Paws::Inspector::ListFindingsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllRulesPackages(sub { },[MaxResults => Int, NextToken => Str])
ListAllRulesPackages([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- rulesPackageArns, passing the object as the first parameter, and the string 'rulesPackageArns' as the second parameter
If not, it will return a a Paws::Inspector::ListRulesPackagesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
PreviewAllAgents(sub { },PreviewAgentsArn => Str, [MaxResults => Int, NextToken => Str])
PreviewAllAgents(PreviewAgentsArn => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- agentPreviews, passing the object as the first parameter, and the string 'agentPreviews' as the second parameter
If not, it will return a a Paws::Inspector::PreviewAgentsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues