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#

can_paginate#

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

accept_administrator_invitation#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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[AwsSecurityFindingUnionTypeDef],  # (1)
) -> BatchImportFindingsResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingTypeDef AwsSecurityFindingOutputTypeDef
  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. boto3 documentation

# batch_update_findings method definition

def batch_update_findings(
    self,
    *,
    FindingIdentifiers: Sequence[AwsSecurityFindingIdentifierTypeDef],  # (1)
    Note: NoteUpdateTypeDef = ...,  # (2)
    Severity: SeverityUpdateTypeDef = ...,  # (3)
    VerificationState: VerificationStateType = ...,  # (4)
    Confidence: int = ...,
    Criticality: int = ...,
    Types: Sequence[str] = ...,
    UserDefinedFields: Mapping[str, str] = ...,
    Workflow: WorkflowUpdateTypeDef = ...,  # (5)
    RelatedFindings: Sequence[RelatedFindingTypeDef] = ...,  # (6)
) -> BatchUpdateFindingsResponseTypeDef:  # (7)
    ...
  1. See AwsSecurityFindingIdentifierTypeDef
  2. See NoteUpdateTypeDef
  3. See SeverityUpdateTypeDef
  4. See VerificationStateType
  5. See WorkflowUpdateTypeDef
  6. See RelatedFindingTypeDef
  7. See BatchUpdateFindingsResponseTypeDef
# batch_update_findings method usage example with argument unpacking

kwargs: BatchUpdateFindingsRequestRequestTypeDef = {  # (1)
    "FindingIdentifiers": ...,
}

parent.batch_update_findings(**kwargs)
  1. See BatchUpdateFindingsRequestRequestTypeDef

batch_update_standards_control_associations#

For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.

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

# batch_update_standards_control_associations method definition

def batch_update_standards_control_associations(
    self,
    *,
    StandardsControlAssociationUpdates: Sequence[StandardsControlAssociationUpdateTypeDef],  # (1)
) -> BatchUpdateStandardsControlAssociationsResponseTypeDef:  # (2)
    ...
  1. See StandardsControlAssociationUpdateTypeDef
  2. See BatchUpdateStandardsControlAssociationsResponseTypeDef
# batch_update_standards_control_associations method usage example with argument unpacking

kwargs: BatchUpdateStandardsControlAssociationsRequestRequestTypeDef = {  # (1)
    "StandardsControlAssociationUpdates": ...,
}

parent.batch_update_standards_control_associations(**kwargs)
  1. See BatchUpdateStandardsControlAssociationsRequestRequestTypeDef

create_action_target#

Creates a custom action target in Security Hub.

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

# create_action_target method definition

def create_action_target(
    self,
    *,
    Name: str,
    Description: str,
    Id: str,
) -> CreateActionTargetResponseTypeDef:  # (1)
    ...
  1. See CreateActionTargetResponseTypeDef
# create_action_target method usage example with argument unpacking

kwargs: CreateActionTargetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Description": ...,
    "Id": ...,
}

parent.create_action_target(**kwargs)
  1. See CreateActionTargetRequestRequestTypeDef

create_automation_rule#

Creates an automation rule based on input parameters.

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

# create_automation_rule method definition

def create_automation_rule(
    self,
    *,
    RuleOrder: int,
    RuleName: str,
    Description: str,
    Criteria: AutomationRulesFindingFiltersTypeDef,  # (1)
    Actions: Sequence[AutomationRulesActionUnionTypeDef],  # (2)
    Tags: Mapping[str, str] = ...,
    RuleStatus: RuleStatusType = ...,  # (3)
    IsTerminal: bool = ...,
) -> CreateAutomationRuleResponseTypeDef:  # (4)
    ...
  1. See AutomationRulesFindingFiltersTypeDef
  2. See AutomationRulesActionTypeDef AutomationRulesActionOutputTypeDef
  3. See RuleStatusType
  4. See CreateAutomationRuleResponseTypeDef
# create_automation_rule method usage example with argument unpacking

kwargs: CreateAutomationRuleRequestRequestTypeDef = {  # (1)
    "RuleOrder": ...,
    "RuleName": ...,
    "Description": ...,
    "Criteria": ...,
    "Actions": ...,
}

parent.create_automation_rule(**kwargs)
  1. See CreateAutomationRuleRequestRequestTypeDef

create_configuration_policy#

Creates a configuration policy with the defined configuration.

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

# create_configuration_policy method definition

def create_configuration_policy(
    self,
    *,
    Name: str,
    ConfigurationPolicy: PolicyTypeDef,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateConfigurationPolicyResponseTypeDef:  # (2)
    ...
  1. See PolicyTypeDef
  2. See CreateConfigurationPolicyResponseTypeDef
# create_configuration_policy method usage example with argument unpacking

kwargs: CreateConfigurationPolicyRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ConfigurationPolicy": ...,
}

parent.create_configuration_policy(**kwargs)
  1. See CreateConfigurationPolicyRequestRequestTypeDef

create_finding_aggregator#

The aggregation Region is now called the home Region.

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

# create_finding_aggregator method definition

def create_finding_aggregator(
    self,
    *,
    RegionLinkingMode: str,
    Regions: Sequence[str] = ...,
) -> CreateFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See CreateFindingAggregatorResponseTypeDef
# create_finding_aggregator method usage example with argument unpacking

kwargs: CreateFindingAggregatorRequestRequestTypeDef = {  # (1)
    "RegionLinkingMode": ...,
}

parent.create_finding_aggregator(**kwargs)
  1. See CreateFindingAggregatorRequestRequestTypeDef

create_insight#

Creates a custom insight in Security Hub.

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

# create_insight method definition

def create_insight(
    self,
    *,
    Name: str,
    Filters: AwsSecurityFindingFiltersTypeDef,  # (1)
    GroupByAttribute: str,
) -> CreateInsightResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingFiltersTypeDef
  2. See CreateInsightResponseTypeDef
# create_insight method usage example with argument unpacking

kwargs: CreateInsightRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Filters": ...,
    "GroupByAttribute": ...,
}

parent.create_insight(**kwargs)
  1. See CreateInsightRequestRequestTypeDef

create_members#

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

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

# create_members method definition

def create_members(
    self,
    *,
    AccountDetails: Sequence[AccountDetailsTypeDef],  # (1)
) -> CreateMembersResponseTypeDef:  # (2)
    ...
  1. See AccountDetailsTypeDef
  2. See CreateMembersResponseTypeDef
# create_members method usage example with argument unpacking

kwargs: CreateMembersRequestRequestTypeDef = {  # (1)
    "AccountDetails": ...,
}

parent.create_members(**kwargs)
  1. See CreateMembersRequestRequestTypeDef

decline_invitations#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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

# decline_invitations method definition

def decline_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeclineInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeclineInvitationsResponseTypeDef
# decline_invitations method usage example with argument unpacking

kwargs: DeclineInvitationsRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.decline_invitations(**kwargs)
  1. See DeclineInvitationsRequestRequestTypeDef

delete_action_target#

Deletes a custom action target from Security Hub.

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

# delete_action_target method definition

def delete_action_target(
    self,
    *,
    ActionTargetArn: str,
) -> DeleteActionTargetResponseTypeDef:  # (1)
    ...
  1. See DeleteActionTargetResponseTypeDef
# delete_action_target method usage example with argument unpacking

kwargs: DeleteActionTargetRequestRequestTypeDef = {  # (1)
    "ActionTargetArn": ...,
}

parent.delete_action_target(**kwargs)
  1. See DeleteActionTargetRequestRequestTypeDef

delete_configuration_policy#

Deletes a configuration policy.

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

# delete_configuration_policy method definition

def delete_configuration_policy(
    self,
    *,
    Identifier: str,
) -> dict[str, Any]:
    ...
# delete_configuration_policy method usage example with argument unpacking

kwargs: DeleteConfigurationPolicyRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_configuration_policy(**kwargs)
  1. See DeleteConfigurationPolicyRequestRequestTypeDef

delete_finding_aggregator#

The aggregation Region is now called the home Region.

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

# delete_finding_aggregator method definition

def delete_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
) -> dict[str, Any]:
    ...
# delete_finding_aggregator method usage example with argument unpacking

kwargs: DeleteFindingAggregatorRequestRequestTypeDef = {  # (1)
    "FindingAggregatorArn": ...,
}

parent.delete_finding_aggregator(**kwargs)
  1. See DeleteFindingAggregatorRequestRequestTypeDef

delete_insight#

Deletes the insight specified by the InsightArn.

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

# delete_insight method definition

def delete_insight(
    self,
    *,
    InsightArn: str,
) -> DeleteInsightResponseTypeDef:  # (1)
    ...
  1. See DeleteInsightResponseTypeDef
# delete_insight method usage example with argument unpacking

kwargs: DeleteInsightRequestRequestTypeDef = {  # (1)
    "InsightArn": ...,
}

parent.delete_insight(**kwargs)
  1. See DeleteInsightRequestRequestTypeDef

delete_invitations#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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

# delete_invitations method definition

def delete_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeleteInvitationsResponseTypeDef
# delete_invitations method usage example with argument unpacking

kwargs: DeleteInvitationsRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.delete_invitations(**kwargs)
  1. See DeleteInvitationsRequestRequestTypeDef

delete_members#

Deletes the specified member accounts from Security Hub.

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

# delete_members method definition

def delete_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef:  # (1)
    ...
  1. See DeleteMembersResponseTypeDef
# delete_members method usage example with argument unpacking

kwargs: DeleteMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.delete_members(**kwargs)
  1. See DeleteMembersRequestRequestTypeDef

describe_action_targets#

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

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

# describe_action_targets method definition

def describe_action_targets(
    self,
    *,
    ActionTargetArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeActionTargetsResponseTypeDef:  # (1)
    ...
  1. See DescribeActionTargetsResponseTypeDef
# describe_action_targets method usage example with argument unpacking

kwargs: DescribeActionTargetsRequestRequestTypeDef = {  # (1)
    "ActionTargetArns": ...,
}

parent.describe_action_targets(**kwargs)
  1. See DescribeActionTargetsRequestRequestTypeDef

describe_hub#

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

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

# describe_hub method definition

def describe_hub(
    self,
    *,
    HubArn: str = ...,
) -> DescribeHubResponseTypeDef:  # (1)
    ...
  1. See DescribeHubResponseTypeDef
# describe_hub method usage example with argument unpacking

kwargs: DescribeHubRequestRequestTypeDef = {  # (1)
    "HubArn": ...,
}

parent.describe_hub(**kwargs)
  1. See DescribeHubRequestRequestTypeDef

describe_organization_configuration#

Returns information about the way your organization is configured in Security Hub.

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

# describe_organization_configuration method definition

def describe_organization_configuration(
    self,
) -> DescribeOrganizationConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationConfigurationResponseTypeDef

describe_products#

Returns information about product integrations in Security Hub.

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

# describe_products method definition

def describe_products(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ProductArn: str = ...,
) -> DescribeProductsResponseTypeDef:  # (1)
    ...
  1. See DescribeProductsResponseTypeDef
# describe_products method usage example with argument unpacking

kwargs: DescribeProductsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_products(**kwargs)
  1. See DescribeProductsRequestRequestTypeDef

describe_standards#

Returns a list of the available standards in Security Hub.

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

# describe_standards method definition

def describe_standards(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStandardsResponseTypeDef:  # (1)
    ...
  1. See DescribeStandardsResponseTypeDef
# describe_standards method usage example with argument unpacking

kwargs: DescribeStandardsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_standards(**kwargs)
  1. See DescribeStandardsRequestRequestTypeDef

describe_standards_controls#

Returns a list of security standards controls.

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

# describe_standards_controls method definition

def describe_standards_controls(
    self,
    *,
    StandardsSubscriptionArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStandardsControlsResponseTypeDef:  # (1)
    ...
  1. See DescribeStandardsControlsResponseTypeDef
# describe_standards_controls method usage example with argument unpacking

kwargs: DescribeStandardsControlsRequestRequestTypeDef = {  # (1)
    "StandardsSubscriptionArn": ...,
}

parent.describe_standards_controls(**kwargs)
  1. See DescribeStandardsControlsRequestRequestTypeDef

disable_import_findings_for_product#

Disables the integration of the specified product with Security Hub.

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

# disable_import_findings_for_product method definition

def disable_import_findings_for_product(
    self,
    *,
    ProductSubscriptionArn: str,
) -> dict[str, Any]:
    ...
# disable_import_findings_for_product method usage example with argument unpacking

kwargs: DisableImportFindingsForProductRequestRequestTypeDef = {  # (1)
    "ProductSubscriptionArn": ...,
}

parent.disable_import_findings_for_product(**kwargs)
  1. See DisableImportFindingsForProductRequestRequestTypeDef

disable_organization_admin_account#

Disables a Security Hub administrator account.

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

# disable_organization_admin_account method definition

def disable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> dict[str, Any]:
    ...
# disable_organization_admin_account method usage example with argument unpacking

kwargs: DisableOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "AdminAccountId": ...,
}

parent.disable_organization_admin_account(**kwargs)
  1. See DisableOrganizationAdminAccountRequestRequestTypeDef

disable_security_hub#

Disables Security Hub in your account only in the current Amazon Web Services Region.

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

# disable_security_hub method definition

def disable_security_hub(
    self,
) -> dict[str, Any]:
    ...

disassociate_from_administrator_account#

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

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

# disassociate_from_administrator_account method definition

def disassociate_from_administrator_account(
    self,
) -> dict[str, Any]:
    ...

disassociate_from_master_account#

This method is deprecated.

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

# disassociate_from_master_account method definition

def disassociate_from_master_account(
    self,
) -> dict[str, Any]:
    ...

disassociate_members#

Disassociates the specified member accounts from the associated administrator account.

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

# disassociate_members method definition

def disassociate_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> dict[str, Any]:
    ...
# disassociate_members method usage example with argument unpacking

kwargs: DisassociateMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.disassociate_members(**kwargs)
  1. See DisassociateMembersRequestRequestTypeDef

enable_import_findings_for_product#

Enables the integration of a partner product with Security Hub.

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

# enable_import_findings_for_product method definition

def enable_import_findings_for_product(
    self,
    *,
    ProductArn: str,
) -> EnableImportFindingsForProductResponseTypeDef:  # (1)
    ...
  1. See EnableImportFindingsForProductResponseTypeDef
# enable_import_findings_for_product method usage example with argument unpacking

kwargs: EnableImportFindingsForProductRequestRequestTypeDef = {  # (1)
    "ProductArn": ...,
}

parent.enable_import_findings_for_product(**kwargs)
  1. See EnableImportFindingsForProductRequestRequestTypeDef

enable_organization_admin_account#

Designates the Security Hub administrator account for an organization.

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

# enable_organization_admin_account method definition

def enable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> dict[str, Any]:
    ...
# enable_organization_admin_account method usage example with argument unpacking

kwargs: EnableOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "AdminAccountId": ...,
}

parent.enable_organization_admin_account(**kwargs)
  1. See EnableOrganizationAdminAccountRequestRequestTypeDef

enable_security_hub#

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

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

# enable_security_hub method definition

def enable_security_hub(
    self,
    *,
    Tags: Mapping[str, str] = ...,
    EnableDefaultStandards: bool = ...,
    ControlFindingGenerator: ControlFindingGeneratorType = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See ControlFindingGeneratorType
# enable_security_hub method usage example with argument unpacking

kwargs: EnableSecurityHubRequestRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.enable_security_hub(**kwargs)
  1. See EnableSecurityHubRequestRequestTypeDef

get_administrator_account#

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

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

# get_administrator_account method definition

def get_administrator_account(
    self,
) -> GetAdministratorAccountResponseTypeDef:  # (1)
    ...
  1. See GetAdministratorAccountResponseTypeDef

get_configuration_policy#

Provides information about a configuration policy.

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

# get_configuration_policy method definition

def get_configuration_policy(
    self,
    *,
    Identifier: str,
) -> GetConfigurationPolicyResponseTypeDef:  # (1)
    ...
  1. See GetConfigurationPolicyResponseTypeDef
# get_configuration_policy method usage example with argument unpacking

kwargs: GetConfigurationPolicyRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_configuration_policy(**kwargs)
  1. See GetConfigurationPolicyRequestRequestTypeDef

get_configuration_policy_association#

Returns the association between a configuration and a target account, organizational unit, or the root.

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

# get_configuration_policy_association method definition

def get_configuration_policy_association(
    self,
    *,
    Target: TargetTypeDef,  # (1)
) -> GetConfigurationPolicyAssociationResponseTypeDef:  # (2)
    ...
  1. See TargetTypeDef
  2. See GetConfigurationPolicyAssociationResponseTypeDef
# get_configuration_policy_association method usage example with argument unpacking

kwargs: GetConfigurationPolicyAssociationRequestRequestTypeDef = {  # (1)
    "Target": ...,
}

parent.get_configuration_policy_association(**kwargs)
  1. See GetConfigurationPolicyAssociationRequestRequestTypeDef

get_enabled_standards#

Returns a list of the standards that are currently enabled.

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

# get_enabled_standards method definition

def get_enabled_standards(
    self,
    *,
    StandardsSubscriptionArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetEnabledStandardsResponseTypeDef:  # (1)
    ...
  1. See GetEnabledStandardsResponseTypeDef
# get_enabled_standards method usage example with argument unpacking

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

parent.get_enabled_standards(**kwargs)
  1. See GetEnabledStandardsRequestRequestTypeDef

get_finding_aggregator#

The aggregation Region is now called the home Region.

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

# get_finding_aggregator method definition

def get_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
) -> GetFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See GetFindingAggregatorResponseTypeDef
# get_finding_aggregator method usage example with argument unpacking

kwargs: GetFindingAggregatorRequestRequestTypeDef = {  # (1)
    "FindingAggregatorArn": ...,
}

parent.get_finding_aggregator(**kwargs)
  1. See GetFindingAggregatorRequestRequestTypeDef

get_finding_history#

Returns history for a Security Hub finding in the last 90 days.

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

# get_finding_history method definition

def get_finding_history(
    self,
    *,
    FindingIdentifier: AwsSecurityFindingIdentifierTypeDef,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetFindingHistoryResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingIdentifierTypeDef
  2. See GetFindingHistoryResponseTypeDef
# get_finding_history method usage example with argument unpacking

kwargs: GetFindingHistoryRequestRequestTypeDef = {  # (1)
    "FindingIdentifier": ...,
}

parent.get_finding_history(**kwargs)
  1. See GetFindingHistoryRequestRequestTypeDef

get_findings#

Returns a list of findings that match the specified criteria.

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

# get_findings method definition

def get_findings(
    self,
    *,
    Filters: AwsSecurityFindingFiltersTypeDef = ...,  # (1)
    SortCriteria: Sequence[SortCriterionTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetFindingsResponseTypeDef:  # (3)
    ...
  1. See AwsSecurityFindingFiltersTypeDef
  2. See SortCriterionTypeDef
  3. See GetFindingsResponseTypeDef
# get_findings method usage example with argument unpacking

kwargs: GetFindingsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.get_findings(**kwargs)
  1. See GetFindingsRequestRequestTypeDef

get_insight_results#

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

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

# get_insight_results method definition

def get_insight_results(
    self,
    *,
    InsightArn: str,
) -> GetInsightResultsResponseTypeDef:  # (1)
    ...
  1. See GetInsightResultsResponseTypeDef
# get_insight_results method usage example with argument unpacking

kwargs: GetInsightResultsRequestRequestTypeDef = {  # (1)
    "InsightArn": ...,
}

parent.get_insight_results(**kwargs)
  1. See GetInsightResultsRequestRequestTypeDef

get_insights#

Lists and describes insights for the specified insight ARNs.

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

# get_insights method definition

def get_insights(
    self,
    *,
    InsightArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetInsightsResponseTypeDef:  # (1)
    ...
  1. See GetInsightsResponseTypeDef
# get_insights method usage example with argument unpacking

kwargs: GetInsightsRequestRequestTypeDef = {  # (1)
    "InsightArns": ...,
}

parent.get_insights(**kwargs)
  1. See GetInsightsRequestRequestTypeDef

get_invitations_count#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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

# get_invitations_count method definition

def get_invitations_count(
    self,
) -> GetInvitationsCountResponseTypeDef:  # (1)
    ...
  1. See GetInvitationsCountResponseTypeDef

get_master_account#

This method is deprecated.

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

# get_master_account method definition

def get_master_account(
    self,
) -> GetMasterAccountResponseTypeDef:  # (1)
    ...
  1. See GetMasterAccountResponseTypeDef

get_members#

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

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

# get_members method definition

def get_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef:  # (1)
    ...
  1. See GetMembersResponseTypeDef
# get_members method usage example with argument unpacking

kwargs: GetMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.get_members(**kwargs)
  1. See GetMembersRequestRequestTypeDef

get_security_control_definition#

Retrieves the definition of a security control.

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

# get_security_control_definition method definition

def get_security_control_definition(
    self,
    *,
    SecurityControlId: str,
) -> GetSecurityControlDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetSecurityControlDefinitionResponseTypeDef
# get_security_control_definition method usage example with argument unpacking

kwargs: GetSecurityControlDefinitionRequestRequestTypeDef = {  # (1)
    "SecurityControlId": ...,
}

parent.get_security_control_definition(**kwargs)
  1. See GetSecurityControlDefinitionRequestRequestTypeDef

invite_members#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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

# invite_members method definition

def invite_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> InviteMembersResponseTypeDef:  # (1)
    ...
  1. See InviteMembersResponseTypeDef
# invite_members method usage example with argument unpacking

kwargs: InviteMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.invite_members(**kwargs)
  1. See InviteMembersRequestRequestTypeDef

list_automation_rules#

A list of automation rules and their metadata for the calling account.

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

# list_automation_rules method definition

def list_automation_rules(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAutomationRulesResponseTypeDef:  # (1)
    ...
  1. See ListAutomationRulesResponseTypeDef
# list_automation_rules method usage example with argument unpacking

kwargs: ListAutomationRulesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_automation_rules(**kwargs)
  1. See ListAutomationRulesRequestRequestTypeDef

list_configuration_policies#

Lists the configuration policies that the Security Hub delegated administrator has created for your organization.

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

# list_configuration_policies method definition

def list_configuration_policies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListConfigurationPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListConfigurationPoliciesResponseTypeDef
# list_configuration_policies method usage example with argument unpacking

kwargs: ListConfigurationPoliciesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_configuration_policies(**kwargs)
  1. See ListConfigurationPoliciesRequestRequestTypeDef

list_configuration_policy_associations#

Provides information about the associations for your configuration policies and self-managed behavior.

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

# list_configuration_policy_associations method definition

def list_configuration_policy_associations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: AssociationFiltersTypeDef = ...,  # (1)
) -> ListConfigurationPolicyAssociationsResponseTypeDef:  # (2)
    ...
  1. See AssociationFiltersTypeDef
  2. See ListConfigurationPolicyAssociationsResponseTypeDef
# list_configuration_policy_associations method usage example with argument unpacking

kwargs: ListConfigurationPolicyAssociationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_configuration_policy_associations(**kwargs)
  1. See ListConfigurationPolicyAssociationsRequestRequestTypeDef

list_enabled_products_for_import#

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

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

# list_enabled_products_for_import method definition

def list_enabled_products_for_import(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEnabledProductsForImportResponseTypeDef:  # (1)
    ...
  1. See ListEnabledProductsForImportResponseTypeDef
# list_enabled_products_for_import method usage example with argument unpacking

kwargs: ListEnabledProductsForImportRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_enabled_products_for_import(**kwargs)
  1. See ListEnabledProductsForImportRequestRequestTypeDef

list_finding_aggregators#

If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator.

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

# list_finding_aggregators method definition

def list_finding_aggregators(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFindingAggregatorsResponseTypeDef:  # (1)
    ...
  1. See ListFindingAggregatorsResponseTypeDef
# list_finding_aggregators method usage example with argument unpacking

kwargs: ListFindingAggregatorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_finding_aggregators(**kwargs)
  1. See ListFindingAggregatorsRequestRequestTypeDef

list_invitations#

We recommend using Organizations instead of Security Hub invitations to manage your member accounts.

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

# list_invitations method definition

def list_invitations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInvitationsResponseTypeDef:  # (1)
    ...
  1. See ListInvitationsResponseTypeDef
# list_invitations method usage example with argument unpacking

kwargs: ListInvitationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_invitations(**kwargs)
  1. See ListInvitationsRequestRequestTypeDef

list_members#

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

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

# list_members method definition

def list_members(
    self,
    *,
    OnlyAssociated: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...
  1. See ListMembersResponseTypeDef
# list_members method usage example with argument unpacking

kwargs: ListMembersRequestRequestTypeDef = {  # (1)
    "OnlyAssociated": ...,
}

parent.list_members(**kwargs)
  1. See ListMembersRequestRequestTypeDef

list_organization_admin_accounts#

Lists the Security Hub administrator accounts.

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

# list_organization_admin_accounts method definition

def list_organization_admin_accounts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationAdminAccountsResponseTypeDef
# list_organization_admin_accounts method usage example with argument unpacking

kwargs: ListOrganizationAdminAccountsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_organization_admin_accounts(**kwargs)
  1. See ListOrganizationAdminAccountsRequestRequestTypeDef

list_security_control_definitions#

Lists all of the security controls that apply to a specified standard.

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

# list_security_control_definitions method definition

def list_security_control_definitions(
    self,
    *,
    StandardsArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSecurityControlDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListSecurityControlDefinitionsResponseTypeDef
# list_security_control_definitions method usage example with argument unpacking

kwargs: ListSecurityControlDefinitionsRequestRequestTypeDef = {  # (1)
    "StandardsArn": ...,
}

parent.list_security_control_definitions(**kwargs)
  1. See ListSecurityControlDefinitionsRequestRequestTypeDef

list_standards_control_associations#

Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.

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

# list_standards_control_associations method definition

def list_standards_control_associations(
    self,
    *,
    SecurityControlId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStandardsControlAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListStandardsControlAssociationsResponseTypeDef
# list_standards_control_associations method usage example with argument unpacking

kwargs: ListStandardsControlAssociationsRequestRequestTypeDef = {  # (1)
    "SecurityControlId": ...,
}

parent.list_standards_control_associations(**kwargs)
  1. See ListStandardsControlAssociationsRequestRequestTypeDef

list_tags_for_resource#

Returns a list of tags associated with a resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_configuration_policy_association#

Associates a target account, organizational unit, or the root with a specified configuration.

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

# start_configuration_policy_association method definition

def start_configuration_policy_association(
    self,
    *,
    ConfigurationPolicyIdentifier: str,
    Target: TargetTypeDef,  # (1)
) -> StartConfigurationPolicyAssociationResponseTypeDef:  # (2)
    ...
  1. See TargetTypeDef
  2. See StartConfigurationPolicyAssociationResponseTypeDef
# start_configuration_policy_association method usage example with argument unpacking

kwargs: StartConfigurationPolicyAssociationRequestRequestTypeDef = {  # (1)
    "ConfigurationPolicyIdentifier": ...,
    "Target": ...,
}

parent.start_configuration_policy_association(**kwargs)
  1. See StartConfigurationPolicyAssociationRequestRequestTypeDef

start_configuration_policy_disassociation#

Disassociates a target account, organizational unit, or the root from a specified configuration.

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

# start_configuration_policy_disassociation method definition

def start_configuration_policy_disassociation(
    self,
    *,
    ConfigurationPolicyIdentifier: str,
    Target: TargetTypeDef = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See TargetTypeDef
# start_configuration_policy_disassociation method usage example with argument unpacking

kwargs: StartConfigurationPolicyDisassociationRequestRequestTypeDef = {  # (1)
    "ConfigurationPolicyIdentifier": ...,
}

parent.start_configuration_policy_disassociation(**kwargs)
  1. See StartConfigurationPolicyDisassociationRequestRequestTypeDef

tag_resource#

Adds one or more tags to a resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes one or more tags from a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_action_target#

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

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

# update_action_target method definition

def update_action_target(
    self,
    *,
    ActionTargetArn: str,
    Name: str = ...,
    Description: str = ...,
) -> dict[str, Any]:
    ...
# update_action_target method usage example with argument unpacking

kwargs: UpdateActionTargetRequestRequestTypeDef = {  # (1)
    "ActionTargetArn": ...,
}

parent.update_action_target(**kwargs)
  1. See UpdateActionTargetRequestRequestTypeDef

update_configuration_policy#

Updates a configuration policy.

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

# update_configuration_policy method definition

def update_configuration_policy(
    self,
    *,
    Identifier: str,
    Name: str = ...,
    Description: str = ...,
    UpdatedReason: str = ...,
    ConfigurationPolicy: PolicyTypeDef = ...,  # (1)
) -> UpdateConfigurationPolicyResponseTypeDef:  # (2)
    ...
  1. See PolicyTypeDef
  2. See UpdateConfigurationPolicyResponseTypeDef
# update_configuration_policy method usage example with argument unpacking

kwargs: UpdateConfigurationPolicyRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_configuration_policy(**kwargs)
  1. See UpdateConfigurationPolicyRequestRequestTypeDef

update_finding_aggregator#

The aggregation Region is now called the home Region.

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

# update_finding_aggregator method definition

def update_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
    RegionLinkingMode: str,
    Regions: Sequence[str] = ...,
) -> UpdateFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See UpdateFindingAggregatorResponseTypeDef
# update_finding_aggregator method usage example with argument unpacking

kwargs: UpdateFindingAggregatorRequestRequestTypeDef = {  # (1)
    "FindingAggregatorArn": ...,
    "RegionLinkingMode": ...,
}

parent.update_finding_aggregator(**kwargs)
  1. See UpdateFindingAggregatorRequestRequestTypeDef

update_findings#

UpdateFindings is a deprecated operation.

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

# update_findings method definition

def update_findings(
    self,
    *,
    Filters: AwsSecurityFindingFiltersTypeDef,  # (1)
    Note: NoteUpdateTypeDef = ...,  # (2)
    RecordState: RecordStateType = ...,  # (3)
) -> dict[str, Any]:
    ...
  1. See AwsSecurityFindingFiltersTypeDef
  2. See NoteUpdateTypeDef
  3. See RecordStateType
# update_findings method usage example with argument unpacking

kwargs: UpdateFindingsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.update_findings(**kwargs)
  1. See UpdateFindingsRequestRequestTypeDef

update_insight#

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

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

# update_insight method definition

def update_insight(
    self,
    *,
    InsightArn: str,
    Name: str = ...,
    Filters: AwsSecurityFindingFiltersTypeDef = ...,  # (1)
    GroupByAttribute: str = ...,
) -> dict[str, Any]:
    ...
  1. See AwsSecurityFindingFiltersTypeDef
# update_insight method usage example with argument unpacking

kwargs: UpdateInsightRequestRequestTypeDef = {  # (1)
    "InsightArn": ...,
}

parent.update_insight(**kwargs)
  1. See UpdateInsightRequestRequestTypeDef

update_organization_configuration#

Updates the configuration of your organization in Security Hub.

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

# update_organization_configuration method definition

def update_organization_configuration(
    self,
    *,
    AutoEnable: bool,
    AutoEnableStandards: AutoEnableStandardsType = ...,  # (1)
    OrganizationConfiguration: OrganizationConfigurationTypeDef = ...,  # (2)
) -> dict[str, Any]:
    ...
  1. See AutoEnableStandardsType
  2. See OrganizationConfigurationTypeDef
# update_organization_configuration method usage example with argument unpacking

kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "AutoEnable": ...,
}

parent.update_organization_configuration(**kwargs)
  1. See UpdateOrganizationConfigurationRequestRequestTypeDef

update_security_control#

Updates the properties of a security control.

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

# update_security_control method definition

def update_security_control(
    self,
    *,
    SecurityControlId: str,
    Parameters: Mapping[str, ParameterConfigurationUnionTypeDef],  # (1)
    LastUpdateReason: str = ...,
) -> dict[str, Any]:
    ...
  1. See ParameterConfigurationTypeDef ParameterConfigurationOutputTypeDef
# update_security_control method usage example with argument unpacking

kwargs: UpdateSecurityControlRequestRequestTypeDef = {  # (1)
    "SecurityControlId": ...,
    "Parameters": ...,
}

parent.update_security_control(**kwargs)
  1. See UpdateSecurityControlRequestRequestTypeDef

update_security_hub_configuration#

Updates configuration options for Security Hub.

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

# update_security_hub_configuration method definition

def update_security_hub_configuration(
    self,
    *,
    AutoEnableControls: bool = ...,
    ControlFindingGenerator: ControlFindingGeneratorType = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See ControlFindingGeneratorType
# update_security_hub_configuration method usage example with argument unpacking

kwargs: UpdateSecurityHubConfigurationRequestRequestTypeDef = {  # (1)
    "AutoEnableControls": ...,
}

parent.update_security_hub_configuration(**kwargs)
  1. See UpdateSecurityHubConfigurationRequestRequestTypeDef

update_standards_control#

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

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

# update_standards_control method definition

def update_standards_control(
    self,
    *,
    StandardsControlArn: str,
    ControlStatus: ControlStatusType = ...,  # (1)
    DisabledReason: str = ...,
) -> dict[str, Any]:
    ...
  1. See ControlStatusType
# update_standards_control method usage example with argument unpacking

kwargs: UpdateStandardsControlRequestRequestTypeDef = {  # (1)
    "StandardsControlArn": ...,
}

parent.update_standards_control(**kwargs)
  1. See UpdateStandardsControlRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("securityhub").get_paginator method with overloads.