AWS.SecurityHub (aws-elixir v0.8.0) View Source

Security 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 .

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.

  • BatchEnableStandards - RateLimit of 1 request per second, BurstLimit of 1 request per second.

  • GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.

  • UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5 requests per second.

  • UpdateStandardsControl - RateLimit of 1 request per second, BurstLimit of 5 requests per second.

  • All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

Link to this section Summary

Functions

Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.

Disables the standards specified by the provided StandardsSubscriptionArns.

Enables the standards specified by the provided StandardsArn.

Imports security findings generated from an integrated product into Security Hub.

Used by Security Hub customers to update information about their investigation into a finding.

Creates a custom action target in Security Hub.

Creates a custom insight in Security Hub.

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account.

Declines invitations to become a member account.

Deletes a custom action target from Security Hub.

Deletes the insight specified by the InsightArn.

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

Deletes the specified member accounts from Security Hub.

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

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

Returns information about the Organizations configuration for Security Hub.

Returns information about product integrations in Security Hub.

Returns a list of the available standards in Security Hub.

Disables the integration of the specified product with Security Hub.

Disables a Security Hub administrator account.

Disables Security Hub in your account only in the current Region.

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

Disassociates the specified member accounts from the associated administrator account.

Enables the integration of a partner product with Security Hub.

Designates the Security Hub administrator account for an organization.

Enables Security Hub for your account in the current Region or the Region you specify in the request.

Provides the details for the Security Hub administrator account for the current member account.

Returns a list of the standards that are currently enabled.

Returns a list of findings that match the specified criteria.

Lists the results of the Security Hub insight specified by the insight ARN.

Lists and describes insights for the specified insight ARNs.

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

This method is deprecated.

Returns the details for the Security Hub member accounts for the specified account IDs.

Invites other AWS accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

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

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

Returns a list of tags associated with a resource.

Adds one or more tags to a resource.

Removes one or more tags from a resource.

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

UpdateFindings is deprecated.

Updates the Security Hub insight identified by the specified insight ARN.

Used to update the configuration related to Organizations.

Updates configuration options for Security Hub.

Used to control whether an individual security standard control is enabled or disabled.

Link to this section Functions

Link to this function

accept_administrator_invitation(client, input, options \\ [])

View Source

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.

Link to this function

accept_invitation(client, input, options \\ [])

View Source

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.

Link to this function

batch_disable_standards(client, input, options \\ [])

View Source

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the AWS Security Hub User Guide.

Link to this function

batch_enable_standards(client, input, options \\ [])

View Source

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 section of the AWS Security Hub User Guide.

Link to this function

batch_import_findings(client, input, options \\ [])

View Source

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.

  • Note

  • UserDefinedFields

  • VerificationState

  • Workflow

Finding providers also should not use BatchImportFindings to update the following attributes.

  • Confidence

  • Criticality

  • RelatedFindings

  • Severity

  • Types

Instead, finding providers use FindingProviderFields to provide values for these attributes.

Link to this function

batch_update_findings(client, input, options \\ [])

View Source

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.

  • Confidence

  • Criticality

  • Note

  • RelatedFindings

  • Severity

  • Types

  • UserDefinedFields

  • VerificationState

  • Workflow

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 in the AWS Security Hub User Guide.

Link to this function

create_action_target(client, input, options \\ [])

View Source

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.

Link to this function

create_insight(client, input, options \\ [])

View Source

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.

Link to this function

create_members(client, input, options \\ [])

View Source

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:

  • Security Hub is not configured to automatically add new accounts in an organization.

  • The account was disassociated or deleted in Security Hub.

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.

Link to this function

decline_invitations(client, input, options \\ [])

View Source

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.

Link to this function

delete_action_target(client, action_target_arn, input, options \\ [])

View Source

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.

Link to this function

delete_insight(client, insight_arn, input, options \\ [])

View Source

Deletes the insight specified by the InsightArn.

Link to this function

delete_invitations(client, input, options \\ [])

View Source

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.

Link to this function

delete_members(client, input, options \\ [])

View Source

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.

Link to this function

describe_action_targets(client, input, options \\ [])

View Source

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

Link to this function

describe_hub(client, hub_arn \\ nil, options \\ [])

View Source

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

Link to this function

describe_organization_configuration(client, options \\ [])

View Source

Returns information about the Organizations configuration for Security Hub.

Can only be called from a Security Hub administrator account.

Link to this function

describe_products(client, max_results \\ nil, next_token \\ nil, product_arn \\ nil, options \\ [])

View Source

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.

Link to this function

describe_standards(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

Link to this function

describe_standards_controls(client, standards_subscription_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

disable_import_findings_for_product(client, product_subscription_arn, input, options \\ [])

View Source

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.

Link to this function

disable_organization_admin_account(client, input, options \\ [])

View Source

Disables a Security Hub administrator account.

Can only be called by the organization management account.

Link to this function

disable_security_hub(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_from_administrator_account(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_from_master_account(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_members(client, input, options \\ [])

View Source

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.

Link to this function

enable_import_findings_for_product(client, input, options \\ [])

View Source

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.

Link to this function

enable_organization_admin_account(client, input, options \\ [])

View Source

Designates the Security Hub administrator account for an organization.

Can only be called by the organization management account.

Link to this function

enable_security_hub(client, input, options \\ [])

View Source

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.

  • CIS AWS Foundations

  • AWS Foundational Security Best Practices

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 in the AWS Security Hub User Guide.

Link to this function

get_administrator_account(client, options \\ [])

View Source

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.

Link to this function

get_enabled_standards(client, input, options \\ [])

View Source

Returns a list of the standards that are currently enabled.

Link to this function

get_findings(client, input, options \\ [])

View Source

Returns a list of findings that match the specified criteria.

Link to this function

get_insight_results(client, insight_arn, options \\ [])

View Source

Lists the results of the Security Hub insight specified by the insight ARN.

Link to this function

get_insights(client, input, options \\ [])

View Source

Lists and describes insights for the specified insight ARNs.

Link to this function

get_invitations_count(client, options \\ [])

View Source

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

Link to this function

get_master_account(client, options \\ [])

View Source

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.

Link to this function

get_members(client, input, options \\ [])

View Source

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.

Link to this function

invite_members(client, input, options \\ [])

View Source

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.

Link to this function

list_enabled_products_for_import(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

Link to this function

list_invitations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_members(client, max_results \\ nil, next_token \\ nil, only_associated \\ nil, options \\ [])

View Source

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.

Link to this function

list_organization_admin_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the Security Hub administrator accounts.

Can only be called by the organization management account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags associated with a resource.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds one or more tags to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags from a resource.

Link to this function

update_action_target(client, action_target_arn, input, options \\ [])

View Source

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

Link to this function

update_findings(client, input, options \\ [])

View Source

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.

Link to this function

update_insight(client, insight_arn, input, options \\ [])

View Source

Updates the Security Hub insight identified by the specified insight ARN.

Link to this function

update_organization_configuration(client, input, options \\ [])

View Source

Used to update the configuration related to Organizations.

Can only be called from a Security Hub administrator account.

Link to this function

update_security_hub_configuration(client, input, options \\ [])

View Source

Updates configuration options for Security Hub.

Link to this function

update_standards_control(client, standards_control_arn, input, options \\ [])

View Source

Used to control whether an individual security standard control is enabled or disabled.