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
create_members 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 invitation
was sent from.
The following throttling limits apply to using Security Hub API operations.
batch_enable_standards -
RateLimit of 1 request per second, BurstLimit of 1 request per
second.
get_findings - RateLimit of 3
requests per second. BurstLimit of 6 requests per second.
update_findings - RateLimit of 1
request per second. BurstLimit of 5 requests per second.
update_standards_control -
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.
securityhub(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
svc <- securityhub(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string"
),
endpoint = "string",
region = "string"
)
)
| accept_invitation | Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from |
| batch_disable_standards | Disables the standards specified by the provided StandardsSubscriptionArns |
| batch_enable_standards | Enables the standards specified by the provided StandardsArn |
| batch_import_findings | Imports security findings generated from an integrated third-party product into Security Hub |
| batch_update_findings | Used by Security Hub customers to update information about their investigation into a finding |
| create_action_target | Creates a custom action target in Security Hub |
| create_insight | Creates a custom insight in Security Hub |
| create_members | Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account |
| decline_invitations | Declines invitations to become a member account |
| delete_action_target | Deletes a custom action target from Security Hub |
| delete_insight | Deletes the insight specified by the InsightArn |
| delete_invitations | Deletes invitations received by the AWS account to become a member account |
| delete_members | Deletes the specified member accounts from Security Hub |
| describe_action_targets | Returns a list of the custom action targets in Security Hub in your account |
| describe_hub | Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub |
| describe_organization_configuration | Returns information about the Organizations configuration for Security Hub |
| describe_products | Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings |
| describe_standards | Returns a list of the available standards in Security Hub |
| describe_standards_controls | Returns a list of security standards controls |
| disable_import_findings_for_product | Disables the integration of the specified product with Security Hub |
| disable_organization_admin_account | Disables a Security Hub administrator account |
| disable_security_hub | Disables Security Hub in your account only in the current Region |
| disassociate_from_master_account | Disassociates the current Security Hub member account from the associated master account |
| disassociate_members | Disassociates the specified member accounts from the associated master account |
| enable_import_findings_for_product | Enables the integration of a partner product with Security Hub |
| enable_organization_admin_account | Designates the Security Hub administrator account for an organization |
| enable_security_hub | Enables Security Hub for your account in the current Region or the Region you specify in the request |
| get_enabled_standards | Returns a list of the standards that are currently enabled |
| get_findings | Returns a list of findings that match the specified criteria |
| get_insight_results | Lists the results of the Security Hub insight specified by the insight ARN |
| get_insights | Lists and describes insights for the specified insight ARNs |
| get_invitations_count | Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation |
| get_master_account | Provides the details for the Security Hub master account for the current member account |
| get_members | Returns the details for the Security Hub member accounts for the specified account IDs |
| invite_members | Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from |
| list_enabled_products_for_import | Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub |
| list_invitations | Lists all Security Hub membership invitations that were sent to the current AWS account |
| list_members | Lists details about all member accounts for the current Security Hub master account |
| list_organization_admin_accounts | Lists the Security Hub administrator accounts |
| list_tags_for_resource | Returns a list of tags associated with a resource |
| tag_resource | Adds one or more tags to a resource |
| untag_resource | Removes one or more tags from a resource |
| update_action_target | Updates the name and description of a custom action target in Security Hub |
| update_findings | UpdateFindings is deprecated |
| update_insight | Updates the Security Hub insight identified by the specified insight ARN |
| update_organization_configuration | Used to update the configuration related to Organizations |
| update_security_hub_configuration | Updates configuration options for Security Hub |
| update_standards_control | Used to control whether an individual security standard control is enabled or disabled |
if (FALSE) {
svc <- securityhub()
svc$accept_invitation(
Foo = 123
)
}
Run the code above in your browser using DataLab