Skip to content

SecurityHubClient#

Index > SecurityHub > SecurityHubClient

Auto-generated documentation for SecurityHub type annotations stubs module mypy-boto3-securityhub.

SecurityHubClient#

Type annotations and code completion for boto3.client("securityhub"). boto3 documentation

# SecurityHubClient usage example

from boto3.session import Session
from mypy_boto3_securityhub.client import SecurityHubClient

def get_securityhub_client() -> SecurityHubClient:
    return Session().client("securityhub")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("securityhub").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("securityhub")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalException,
    client.exceptions.InvalidAccessException,
    client.exceptions.InvalidInputException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceConflictException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_securityhub.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

accept_administrator_invitation#

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

Type annotations and code completion for boto3.client("securityhub").accept_administrator_invitation method. boto3 documentation

# accept_administrator_invitation method definition

def accept_administrator_invitation(
    self,
    *,
    AdministratorId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...
# accept_administrator_invitation method usage example with argument unpacking

kwargs: AcceptAdministratorInvitationRequestRequestTypeDef = {  # (1)
    "AdministratorId": ...,
    "InvitationId": ...,
}

parent.accept_administrator_invitation(**kwargs)
  1. See AcceptAdministratorInvitationRequestRequestTypeDef

accept_invitation#

This method is deprecated.

Type annotations and code completion for boto3.client("securityhub").accept_invitation method. boto3 documentation

# accept_invitation method definition

def accept_invitation(
    self,
    *,
    MasterId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...
# accept_invitation method usage example with argument unpacking

kwargs: AcceptInvitationRequestRequestTypeDef = {  # (1)
    "MasterId": ...,
    "InvitationId": ...,
}

parent.accept_invitation(**kwargs)
  1. See AcceptInvitationRequestRequestTypeDef

batch_delete_automation_rules#

Deletes one or more automation rules.

Type annotations and code completion for boto3.client("securityhub").batch_delete_automation_rules method. boto3 documentation

# batch_delete_automation_rules method definition

def batch_delete_automation_rules(
    self,
    *,
    AutomationRulesArns: Sequence[str],
) -> BatchDeleteAutomationRulesResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteAutomationRulesResponseTypeDef 
# batch_delete_automation_rules method usage example with argument unpacking

kwargs: BatchDeleteAutomationRulesRequestRequestTypeDef = {  # (1)
    "AutomationRulesArns": ...,
}

parent.batch_delete_automation_rules(**kwargs)
  1. See BatchDeleteAutomationRulesRequestRequestTypeDef

batch_disable_standards#

Disables the standards specified by the provided StandardsSubscriptionArns.

Type annotations and code completion for boto3.client("securityhub").batch_disable_standards method. boto3 documentation

# batch_disable_standards method definition

def batch_disable_standards(
    self,
    *,
    StandardsSubscriptionArns: Sequence[str],
) -> BatchDisableStandardsResponseTypeDef:  # (1)
    ...
  1. See BatchDisableStandardsResponseTypeDef 
# batch_disable_standards method usage example with argument unpacking

kwargs: BatchDisableStandardsRequestRequestTypeDef = {  # (1)
    "StandardsSubscriptionArns": ...,
}

parent.batch_disable_standards(**kwargs)
  1. See BatchDisableStandardsRequestRequestTypeDef

batch_enable_standards#

Enables the standards specified by the provided StandardsArn.

Type annotations and code completion for boto3.client("securityhub").batch_enable_standards method. boto3 documentation

# batch_enable_standards method definition

def batch_enable_standards(
    self,
    *,
    StandardsSubscriptionRequests: Sequence[StandardsSubscriptionRequestTypeDef],  # (1)
) -> BatchEnableStandardsResponseTypeDef:  # (2)
    ...
  1. See StandardsSubscriptionRequestTypeDef
  2. See BatchEnableStandardsResponseTypeDef 
# batch_enable_standards method usage example with argument unpacking

kwargs: BatchEnableStandardsRequestRequestTypeDef = {  # (1)
    "StandardsSubscriptionRequests": ...,
}

parent.batch_enable_standards(**kwargs)
  1. See BatchEnableStandardsRequestRequestTypeDef

batch_get_automation_rules#

Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).

Type annotations and code completion for boto3.client("securityhub").batch_get_automation_rules method. boto3 documentation

# batch_get_automation_rules method definition

def batch_get_automation_rules(
    self,
    *,
    AutomationRulesArns: Sequence[str],
) -> BatchGetAutomationRulesResponseTypeDef:  # (1)
    ...
  1. See BatchGetAutomationRulesResponseTypeDef 
# batch_get_automation_rules method usage example with argument unpacking

kwargs: BatchGetAutomationRulesRequestRequestTypeDef = {  # (1)
    "AutomationRulesArns": ...,
}

parent.batch_get_automation_rules(**kwargs)
  1. See BatchGetAutomationRulesRequestRequestTypeDef

batch_get_configuration_policy_associations#

Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.

Type annotations and code completion for boto3.client("securityhub").batch_get_configuration_policy_associations method. boto3 documentation

# batch_get_configuration_policy_associations method definition

def batch_get_configuration_policy_associations(
    self,
    *,
    ConfigurationPolicyAssociationIdentifiers: Sequence[ConfigurationPolicyAssociationTypeDef],  # (1)
) -> BatchGetConfigurationPolicyAssociationsResponseTypeDef:  # (2)
    ...
  1. See ConfigurationPolicyAssociationTypeDef
  2. See BatchGetConfigurationPolicyAssociationsResponseTypeDef 
# batch_get_configuration_policy_associations method usage example with argument unpacking

kwargs: BatchGetConfigurationPolicyAssociationsRequestRequestTypeDef = {  # (1)
    "ConfigurationPolicyAssociationIdentifiers": ...,
}

parent.batch_get_configuration_policy_associations(**kwargs)
  1. See BatchGetConfigurationPolicyAssociationsRequestRequestTypeDef

batch_get_security_controls#

Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.

Type annotations and code completion for boto3.client("securityhub").batch_get_security_controls method. boto3 documentation

# batch_get_security_controls method definition

def batch_get_security_controls(
    self,
    *,
    SecurityControlIds: Sequence[str],
) -> BatchGetSecurityControlsResponseTypeDef:  # (1)
    ...
  1. See BatchGetSecurityControlsResponseTypeDef 
# batch_get_security_controls method usage example with argument unpacking

kwargs: BatchGetSecurityControlsRequestRequestTypeDef = {  # (1)
    "SecurityControlIds": ...,
}

parent.batch_get_security_controls(**kwargs)
  1. See BatchGetSecurityControlsRequestRequestTypeDef

batch_get_standards_control_associations#

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.

Type annotations and code completion for boto3.client("securityhub").batch_get_standards_control_associations method. boto3 documentation

# batch_get_standards_control_associations method definition

def batch_get_standards_control_associations(
    self,
    *,
    StandardsControlAssociationIds: Sequence[StandardsControlAssociationIdTypeDef],  # (1)
) -> BatchGetStandardsControlAssociationsResponseTypeDef:  # (2)
    ...
  1. See StandardsControlAssociationIdTypeDef
  2. See BatchGetStandardsControlAssociationsResponseTypeDef 
# batch_get_standards_control_associations method usage example with argument unpacking

kwargs: BatchGetStandardsControlAssociationsRequestRequestTypeDef = {  # (1)
    "StandardsControlAssociationIds": ...,
}

parent.batch_get_standards_control_associations(**kwargs)
  1. See BatchGetStandardsControlAssociationsRequestRequestTypeDef

batch_import_findings#

Imports security findings generated by a finding provider into Security Hub.

Type annotations and code completion for boto3.client("securityhub").batch_import_findings method. boto3 documentation

# batch_import_findings method definition

def batch_import_findings(
    self,
    *,
    Findings: Sequence[AwsSecurityFindingTypeDef],  # (1)
) -> BatchImportFindingsResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingTypeDef
  2. See BatchImportFindingsResponseTypeDef 
# batch_import_findings method usage example with argument unpacking

kwargs: BatchImportFindingsRequestRequestTypeDef = {  # (1)
    "Findings": ...,
}

parent.batch_import_findings(**kwargs)
  1. See BatchImportFindingsRequestRequestTypeDef

batch_update_automation_rules#

Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.

Type annotations and code completion for boto3.client("securityhub").batch_update_automation_rules method. boto3 documentation

# batch_update_automation_rules method definition

def batch_update_automation_rules(
    self,
    *,
    UpdateAutomationRulesRequestItems: Sequence[UpdateAutomationRulesRequestItemTypeDef],  # (1)
) -> BatchUpdateAutomationRulesResponseTypeDef:  # (2)
    ...
  1. See UpdateAutomationRulesRequestItemTypeDef
  2. See BatchUpdateAutomationRulesResponseTypeDef 
# batch_update_automation_rules method usage example with argument unpacking

kwargs: BatchUpdateAutomationRulesRequestRequestTypeDef = {  # (1)
    "UpdateAutomationRulesRequestItems": ...,
}

parent.batch_update_automation_rules(**kwargs)
  1. See BatchUpdateAutomationRulesRequestRequestTypeDef

batch_update_findings#

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

Type annotations and code completion for boto3.client("securityhub").batch_update_findings method.