![]() |
![]()
| ![]() |
![]()
NAMEPaws::SecurityHub - Perl Interface to AWS AWS SecurityHub SYNOPSISuse 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' } ], ); DESCRIPTIONSecurity Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. 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 administrator 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 invitation was sent from. The following throttling limits apply to using Security Hub API operations.
For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26> METHODSAcceptAdministratorInvitationEach argument is described in detail in: Paws::SecurityHub::AcceptAdministratorInvitation Returns: a Paws::SecurityHub::AcceptAdministratorInvitationResponse instance Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account. AcceptInvitationEach argument is described in detail in: Paws::SecurityHub::AcceptInvitation Returns: a Paws::SecurityHub::AcceptInvitationResponse instance This method is deprecated. Instead, use "AcceptAdministratorInvitation". The Security Hub console continues to use "AcceptInvitation". It will eventually change to use "AcceptAdministratorInvitation". Any IAM policies that specifically control access to this function must continue to use "AcceptInvitation". You should also add "AcceptAdministratorInvitation" to your policies to ensure that the correct permissions are in place after the console begins to use "AcceptAdministratorInvitation". Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account. BatchDisableStandardsEach 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 Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the AWS Security Hub User Guide. BatchEnableStandardsEach argument is described in detail in: Paws::SecurityHub::BatchEnableStandards Returns: a Paws::SecurityHub::BatchEnableStandardsResponse instance Enables the standards specified by the provided "StandardsArn". To obtain the ARN for a standard, use the " DescribeStandards " operation. For more information, see the Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the AWS Security Hub User Guide. BatchImportFindingsEach argument is described in detail in: Paws::SecurityHub::BatchImportFindings Returns: a Paws::SecurityHub::BatchImportFindingsResponse instance Imports security findings generated from an integrated 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. After a finding is created, "BatchImportFindings" cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.
Finding providers also should not use "BatchImportFindings" to update the following attributes.
Instead, finding providers use "FindingProviderFields" to provide values for these attributes. BatchUpdateFindings
Each argument is described in detail in: Paws::SecurityHub::BatchUpdateFindings Returns: a Paws::SecurityHub::BatchUpdateFindingsResponse instance Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from "BatchUpdateFindings" do not affect the value of "UpdatedAt" for a finding. Administrator and member accounts can use "BatchUpdateFindings" to update the following finding fields and objects.
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) in the AWS Security Hub User Guide. CreateActionTargetEach 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. CreateInsightEach 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. To group the related findings in the insight, use the "GroupByAttribute". CreateMembersEach 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 administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account. "CreateMembers" is always used to add accounts that are not organization members. For accounts that are part of an organization, "CreateMembers" is only used in the following cases:
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the " EnableSecurityHub " operation. For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the " InviteMembers " operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub. Accounts that are part of an organization do not receive an invitation. They automatically become a member account in Security Hub. A permissions policy is added that permits the administrator account to view the findings generated in the member account. When Security Hub is enabled in a member account, the member account findings are also visible to the administrator account. To remove the association between the administrator and member accounts, use the " DisassociateFromMasterAccount " or " DisassociateMembers " operation. DeclineInvitationsEach argument is described in detail in: Paws::SecurityHub::DeclineInvitations Returns: a Paws::SecurityHub::DeclineInvitationsResponse instance Declines invitations to become a member account. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations. DeleteActionTargetEach 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 does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action. DeleteInsightEach argument is described in detail in: Paws::SecurityHub::DeleteInsight Returns: a Paws::SecurityHub::DeleteInsightResponse instance Deletes the insight specified by the "InsightArn". DeleteInvitationsEach 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. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations. DeleteMembersEach argument is described in detail in: Paws::SecurityHub::DeleteMembers Returns: a Paws::SecurityHub::DeleteMembersResponse instance Deletes the specified member accounts from Security Hub. Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually. DescribeActionTargets
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
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. DescribeOrganizationConfigurationEach argument is described in detail in: Paws::SecurityHub::DescribeOrganizationConfiguration Returns: a Paws::SecurityHub::DescribeOrganizationConfigurationResponse instance Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account. DescribeProducts
Each argument is described in detail in: Paws::SecurityHub::DescribeProducts Returns: a Paws::SecurityHub::DescribeProductsResponse instance Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations. DescribeStandards
Each argument is described in detail in: Paws::SecurityHub::DescribeStandards Returns: a Paws::SecurityHub::DescribeStandardsResponse instance Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description. DescribeStandardsControls
Each argument is described in detail in: Paws::SecurityHub::DescribeStandardsControls Returns: a Paws::SecurityHub::DescribeStandardsControlsResponse instance Returns a list of security standards controls. For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information. DisableImportFindingsForProductEach 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. After the integration is disabled, findings from that product are no longer sent to Security Hub. DisableOrganizationAdminAccountEach argument is described in detail in: Paws::SecurityHub::DisableOrganizationAdminAccount Returns: a Paws::SecurityHub::DisableOrganizationAdminAccountResponse instance Disables a Security Hub administrator account. Can only be called by the organization management account. DisableSecurityHubEach 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 an administrator 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 cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub. DisassociateFromAdministratorAccountEach argument is described in detail in: Paws::SecurityHub::DisassociateFromAdministratorAccount Returns: a Paws::SecurityHub::DisassociateFromAdministratorAccountResponse instance Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account. DisassociateFromMasterAccountEach argument is described in detail in: Paws::SecurityHub::DisassociateFromMasterAccount Returns: a Paws::SecurityHub::DisassociateFromMasterAccountResponse instance This method is deprecated. Instead, use "DisassociateFromAdministratorAccount". The Security Hub console continues to use "DisassociateFromMasterAccount". It will eventually change to use "DisassociateFromAdministratorAccount". Any IAM policies that specifically control access to this function must continue to use "DisassociateFromMasterAccount". You should also add "DisassociateFromAdministratorAccount" to your policies to ensure that the correct permissions are in place after the console begins to use "DisassociateFromAdministratorAccount". Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account. DisassociateMembersEach argument is described in detail in: Paws::SecurityHub::DisassociateMembers Returns: a Paws::SecurityHub::DisassociateMembersResponse instance Disassociates the specified member accounts from the associated administrator account. Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually. EnableImportFindingsForProductEach 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 permissions policy that grants permission for the product to send findings to Security Hub is applied. EnableOrganizationAdminAccountEach argument is described in detail in: Paws::SecurityHub::EnableOrganizationAdminAccount Returns: a Paws::SecurityHub::EnableOrganizationAdminAccountResponse instance Designates the Security Hub administrator account for an organization. Can only be called by the organization management account. EnableSecurityHub
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 other services that are integrated with Security Hub. When you use the "EnableSecurityHub" operation to enable Security Hub, you also automatically enable the following standards.
You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the automatically enabled standards, set "EnableDefaultStandards" to "false". After you enable Security Hub, to enable a standard, use the " BatchEnableStandards " operation. To disable a standard, use the " BatchDisableStandards " operation. To learn more, see Setting Up AWS Security Hub (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) in the AWS Security Hub User Guide. GetAdministratorAccountEach argument is described in detail in: Paws::SecurityHub::GetAdministratorAccount Returns: a Paws::SecurityHub::GetAdministratorAccountResponse instance Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually. GetEnabledStandards
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
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. GetInsightResultsEach argument is described in detail in: Paws::SecurityHub::GetInsightResults Returns: a Paws::SecurityHub::GetInsightResultsResponse instance Lists the results of the Security Hub insight specified by the insight ARN. GetInsights
Each argument is described in detail in: Paws::SecurityHub::GetInsights Returns: a Paws::SecurityHub::GetInsightsResponse instance Lists and describes insights for the specified insight ARNs. GetInvitationsCountEach 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. GetMasterAccountEach argument is described in detail in: Paws::SecurityHub::GetMasterAccount Returns: a Paws::SecurityHub::GetMasterAccountResponse instance This method is deprecated. Instead, use "GetAdministratorAccount". The Security Hub console continues to use "GetMasterAccount". It will eventually change to use "GetAdministratorAccount". Any IAM policies that specifically control access to this function must continue to use "GetMasterAccount". You should also add "GetAdministratorAccount" to your policies to ensure that the correct permissions are in place after the console begins to use "GetAdministratorAccount". Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually. GetMembersEach argument is described in detail in: Paws::SecurityHub::GetMembers Returns: a Paws::SecurityHub::GetMembersResponse instance Returns the details for the Security Hub member accounts for the specified account IDs. An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The results include both member accounts that are managed using Organizations and accounts that were invited manually. InviteMembersEach 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 administrator account that the invitation is sent from. This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations. Before you can use this action to invite a member, you must first use the " CreateMembers " action to create the member account in Security Hub. When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account. ListEnabledProductsForImport
Each argument is described in detail in: Paws::SecurityHub::ListEnabledProductsForImport Returns: a Paws::SecurityHub::ListEnabledProductsForImportResponse instance Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub. ListInvitations
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. This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with AWS Organizations do not receive invitations. ListMembers
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 administrator account. The results include both member accounts that belong to an organization and member accounts that were invited manually. ListOrganizationAdminAccounts
Each argument is described in detail in: Paws::SecurityHub::ListOrganizationAdminAccounts Returns: a Paws::SecurityHub::ListOrganizationAdminAccountsResponse instance Lists the Security Hub administrator accounts. Can only be called by the organization management account. ListTagsForResourceEach argument is described in detail in: Paws::SecurityHub::ListTagsForResource Returns: a Paws::SecurityHub::ListTagsForResourceResponse instance Returns a list of tags associated with a resource. TagResourceEach argument is described in detail in: Paws::SecurityHub::TagResource Returns: a Paws::SecurityHub::TagResourceResponse instance Adds one or more tags to a resource. UntagResourceEach argument is described in detail in: Paws::SecurityHub::UntagResource Returns: a Paws::SecurityHub::UntagResourceResponse instance Removes one or more tags from a resource. UpdateActionTarget
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
Each argument is described in detail in: Paws::SecurityHub::UpdateFindings Returns: a Paws::SecurityHub::UpdateFindingsResponse instance "UpdateFindings" is deprecated. Instead of "UpdateFindings", use "BatchUpdateFindings". 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
Each argument is described in detail in: Paws::SecurityHub::UpdateInsight Returns: a Paws::SecurityHub::UpdateInsightResponse instance Updates the Security Hub insight identified by the specified insight ARN. UpdateOrganizationConfigurationEach argument is described in detail in: Paws::SecurityHub::UpdateOrganizationConfiguration Returns: a Paws::SecurityHub::UpdateOrganizationConfigurationResponse instance Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account. UpdateSecurityHubConfiguration
Each argument is described in detail in: Paws::SecurityHub::UpdateSecurityHubConfiguration Returns: a Paws::SecurityHub::UpdateSecurityHubConfigurationResponse instance Updates configuration options for Security Hub. UpdateStandardsControl
Each argument is described in detail in: Paws::SecurityHub::UpdateStandardsControl Returns: a Paws::SecurityHub::UpdateStandardsControlResponse instance Used to control whether an individual security standard control is enabled or disabled. PAGINATORSPaginator 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 "param"s; 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 "param"s; 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 "param"s; 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 "param"s; 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 "param"s; 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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. SEE ALSOThis service class forms part of Paws BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|