NAME

Paws::SecurityHub - Perl Interface to AWS AWS SecurityHub

SYNOPSIS

  use Paws;

  my $obj = Paws->service('SecurityHub');
  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

Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on CIS AWS Foundations compliance checks. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) .

When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to. For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invite was sent from.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26

METHODS

AcceptInvitation

[InvitationId => Str]
[MasterId => Str]

Each argument is described in detail in: Paws::SecurityHub::AcceptInvitation

Returns: a Paws::SecurityHub::AcceptInvitationResponse instance

Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

BatchDisableStandards

StandardsSubscriptionArns => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SecurityHub::BatchDisableStandards

Returns: a Paws::SecurityHub::BatchDisableStandardsResponse instance

Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Standards Supported in AWS Security Hub (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html).

BatchEnableStandards

StandardsSubscriptionRequests => ArrayRef[Paws::SecurityHub::StandardsSubscriptionRequest]

Each argument is described in detail in: Paws::SecurityHub::BatchEnableStandards

Returns: a Paws::SecurityHub::BatchEnableStandardsResponse instance

Enables the standards specified by the provided standardsArn. In this release, only CIS AWS Foundations standards are supported. For more information, see Standards Supported in AWS Security Hub (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html).

BatchImportFindings

Findings => ArrayRef[Paws::SecurityHub::AwsSecurityFinding]

Each argument is described in detail in: Paws::SecurityHub::BatchImportFindings

Returns: a Paws::SecurityHub::BatchImportFindingsResponse instance

Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

CreateActionTarget

Description => Str
Id => Str
Name => Str

Each argument is described in detail in: Paws::SecurityHub::CreateActionTarget

Returns: a Paws::SecurityHub::CreateActionTargetResponse instance

Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

CreateInsight

Filters => Paws::SecurityHub::AwsSecurityFindingFilters
GroupByAttribute => Str
Name => Str

Each argument is described in detail in: Paws::SecurityHub::CreateInsight

Returns: a Paws::SecurityHub::CreateInsightResponse instance

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the GroupByAttribute to group the related findings in the insight.

CreateMembers

[AccountDetails => ArrayRef[Paws::SecurityHub::AccountDetails]]

Each argument is described in detail in: Paws::SecurityHub::CreateMembers

Returns: a Paws::SecurityHub::CreateMembersResponse instance

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. You can use the EnableSecurityHub to enable Security Hub.

After you use CreateMembers to create member account associations in Security Hub, you need to use the InviteMembers action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start being sent to both the member and master accounts.

You can remove the association between the master and member accounts by using the DisassociateFromMasterAccount or DisassociateMembers operation.

DeclineInvitations

[AccountIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::DeclineInvitations

Returns: a Paws::SecurityHub::DeclineInvitationsResponse instance

Declines invitations to become a member account.

DeleteActionTarget

ActionTargetArn => Str

Each argument is described in detail in: Paws::SecurityHub::DeleteActionTarget

Returns: a Paws::SecurityHub::DeleteActionTargetResponse instance

Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

DeleteInsight

InsightArn => Str

Each argument is described in detail in: Paws::SecurityHub::DeleteInsight

Returns: a Paws::SecurityHub::DeleteInsightResponse instance

Deletes the insight specified by the InsightArn.

DeleteInvitations

[AccountIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::DeleteInvitations

Returns: a Paws::SecurityHub::DeleteInvitationsResponse instance

Deletes invitations received by the AWS account to become a member account.

DeleteMembers

[AccountIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::DeleteMembers

Returns: a Paws::SecurityHub::DeleteMembersResponse instance

Deletes the specified member accounts from Security Hub.

DescribeActionTargets

[ActionTargetArns => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SecurityHub::DescribeActionTargets

Returns: a Paws::SecurityHub::DescribeActionTargetsResponse instance

Returns a list of the custom action targets in Security Hub in your account.

DescribeHub

[HubArn => Str]

Each argument is described in detail in: Paws::SecurityHub::DescribeHub

Returns: a Paws::SecurityHub::DescribeHubResponse instance

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

DescribeProducts

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SecurityHub::DescribeProducts

Returns: a Paws::SecurityHub::DescribeProductsResponse instance

Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.

DisableImportFindingsForProduct

ProductSubscriptionArn => Str

Each argument is described in detail in: Paws::SecurityHub::DisableImportFindingsForProduct

Returns: a Paws::SecurityHub::DisableImportFindingsForProductResponse instance

Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.

DisableSecurityHub

Each argument is described in detail in: Paws::SecurityHub::DisableSecurityHub

Returns: a Paws::SecurityHub::DisableSecurityHubResponse instance

Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.

When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.

DisassociateFromMasterAccount

Each argument is described in detail in: Paws::SecurityHub::DisassociateFromMasterAccount

Returns: a Paws::SecurityHub::DisassociateFromMasterAccountResponse instance

Disassociates the current Security Hub member account from the associated master account.

DisassociateMembers

[AccountIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::DisassociateMembers

Returns: a Paws::SecurityHub::DisassociateMembersResponse instance

Disassociates the specified member accounts from the associated master account.

EnableImportFindingsForProduct

ProductArn => Str

Each argument is described in detail in: Paws::SecurityHub::EnableImportFindingsForProduct

Returns: a Paws::SecurityHub::EnableImportFindingsForProductResponse instance

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.

EnableSecurityHub

[Tags => Paws::SecurityHub::TagMap]

Each argument is described in detail in: Paws::SecurityHub::EnableSecurityHub

Returns: a Paws::SecurityHub::EnableSecurityHubResponse instance

Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie. To learn more, see Setting Up AWS Security Hub (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html).

GetEnabledStandards

[MaxResults => Int]
[NextToken => Str]
[StandardsSubscriptionArns => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::GetEnabledStandards

Returns: a Paws::SecurityHub::GetEnabledStandardsResponse instance

Returns a list of the standards that are currently enabled.

GetFindings

[Filters => Paws::SecurityHub::AwsSecurityFindingFilters]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::SecurityHub::SortCriterion]]

Each argument is described in detail in: Paws::SecurityHub::GetFindings

Returns: a Paws::SecurityHub::GetFindingsResponse instance

Returns a list of findings that match the specified criteria.

GetInsightResults

InsightArn => Str

Each argument is described in detail in: Paws::SecurityHub::GetInsightResults

Returns: a Paws::SecurityHub::GetInsightResultsResponse instance

Lists the results of the Security Hub insight that the insight ARN specifies.

GetInsights

[InsightArns => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SecurityHub::GetInsights

Returns: a Paws::SecurityHub::GetInsightsResponse instance

Lists and describes insights that insight ARNs specify.

GetInvitationsCount

Each argument is described in detail in: Paws::SecurityHub::GetInvitationsCount

Returns: a Paws::SecurityHub::GetInvitationsCountResponse instance

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

GetMasterAccount

Each argument is described in detail in: Paws::SecurityHub::GetMasterAccount

Returns: a Paws::SecurityHub::GetMasterAccountResponse instance

Provides the details for the Security Hub master account to the current member account.

GetMembers

AccountIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SecurityHub::GetMembers

Returns: a Paws::SecurityHub::GetMembersResponse instance

Returns the details on the Security Hub member accounts that the account IDs specify.

InviteMembers

[AccountIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SecurityHub::InviteMembers

Returns: a Paws::SecurityHub::InviteMembersResponse instance

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the CreateMembers action. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from member account.

ListEnabledProductsForImport

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SecurityHub::ListEnabledProductsForImport

Returns: a Paws::SecurityHub::ListEnabledProductsForImportResponse instance

Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.

ListInvitations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SecurityHub::ListInvitations

Returns: a Paws::SecurityHub::ListInvitationsResponse instance

Lists all Security Hub membership invitations that were sent to the current AWS account.

ListMembers

[MaxResults => Int]
[NextToken => Str]
[OnlyAssociated => Bool]

Each argument is described in detail in: Paws::SecurityHub::ListMembers

Returns: a Paws::SecurityHub::ListMembersResponse instance

Lists details about all member accounts for the current Security Hub master account.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::SecurityHub::ListTagsForResource

Returns: a Paws::SecurityHub::ListTagsForResourceResponse instance

Returns a list of tags associated with a resource.

TagResource

ResourceArn => Str
Tags => Paws::SecurityHub::TagMap

Each argument is described in detail in: Paws::SecurityHub::TagResource

Returns: a Paws::SecurityHub::TagResourceResponse instance

Adds one or more tags to a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SecurityHub::UntagResource

Returns: a Paws::SecurityHub::UntagResourceResponse instance

Removes one or more tags from a resource.

UpdateActionTarget

ActionTargetArn => Str
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::SecurityHub::UpdateActionTarget

Returns: a Paws::SecurityHub::UpdateActionTargetResponse instance

Updates the name and description of a custom action target in Security Hub.

UpdateFindings

Filters => Paws::SecurityHub::AwsSecurityFindingFilters
[Note => Paws::SecurityHub::NoteUpdate]
[RecordState => Str]

Each argument is described in detail in: Paws::SecurityHub::UpdateFindings

Returns: a Paws::SecurityHub::UpdateFindingsResponse instance

Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

UpdateInsight

InsightArn => Str
[Filters => Paws::SecurityHub::AwsSecurityFindingFilters]
[GroupByAttribute => Str]
[Name => Str]

Each argument is described in detail in: Paws::SecurityHub::UpdateInsight

Returns: a Paws::SecurityHub::UpdateInsightResponse instance

Updates the Security Hub insight that the insight ARN specifies.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllEnabledStandards(sub { },[MaxResults => Int, NextToken => Str, StandardsSubscriptionArns => ArrayRef[Str|Undef]])

GetAllEnabledStandards([MaxResults => Int, NextToken => Str, StandardsSubscriptionArns => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - StandardsSubscriptions, passing the object as the first parameter, and the string 'StandardsSubscriptions' as the second parameter 

If not, it will return a a Paws::SecurityHub::GetEnabledStandardsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllFindings(sub { },[Filters => Paws::SecurityHub::AwsSecurityFindingFilters, MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::SecurityHub::SortCriterion]])

GetAllFindings([Filters => Paws::SecurityHub::AwsSecurityFindingFilters, MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::SecurityHub::SortCriterion]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Findings, passing the object as the first parameter, and the string 'Findings' as the second parameter 

If not, it will return a a Paws::SecurityHub::GetFindingsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllInsights(sub { },[InsightArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

GetAllInsights([InsightArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Insights, passing the object as the first parameter, and the string 'Insights' as the second parameter 

If not, it will return a a Paws::SecurityHub::GetInsightsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEnabledProductsForImport(sub { },[MaxResults => Int, NextToken => Str])

ListAllEnabledProductsForImport([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ProductSubscriptions, passing the object as the first parameter, and the string 'ProductSubscriptions' as the second parameter 

If not, it will return a a Paws::SecurityHub::ListEnabledProductsForImportResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllInvitations(sub { },[MaxResults => Int, NextToken => Str])

ListAllInvitations([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Invitations, passing the object as the first parameter, and the string 'Invitations' as the second parameter 

If not, it will return a a Paws::SecurityHub::ListInvitationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllMembers(sub { },[MaxResults => Int, NextToken => Str, OnlyAssociated => Bool])

ListAllMembers([MaxResults => Int, NextToken => Str, OnlyAssociated => Bool])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Members, passing the object as the first parameter, and the string 'Members' as the second parameter 

If not, it will return a a Paws::SecurityHub::ListMembersResponse instance with all the params; 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