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

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.

Usage example
client = boto3.client("securityhub")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.InternalException,
    client.InvalidAccessException,
    client.InvalidInputException,
    client.LimitExceededException,
    client.ResourceConflictException,
    client.ResourceNotFoundException,
) as e:
    print(e)
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

Method definition
def accept_administrator_invitation(
    self,
    *,
    AdministratorId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def accept_invitation(
    self,
    *,
    MasterId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AcceptInvitationRequestRequestTypeDef = {  # (1)
    "MasterId": ...,
    "InvitationId": ...,
}

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

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

Method definition
def batch_disable_standards(
    self,
    *,
    StandardsSubscriptionArns: Sequence[str],
) -> BatchDisableStandardsResponseTypeDef:  # (1)
    ...
  1. See BatchDisableStandardsResponseTypeDef
Usage example with kwargs
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

Method definition
def batch_enable_standards(
    self,
    *,
    StandardsSubscriptionRequests: Sequence[StandardsSubscriptionRequestTypeDef],  # (1)
) -> BatchEnableStandardsResponseTypeDef:  # (2)
    ...
  1. See StandardsSubscriptionRequestTypeDef
  2. See BatchEnableStandardsResponseTypeDef
Usage example with kwargs
kwargs: BatchEnableStandardsRequestRequestTypeDef = {  # (1)
    "StandardsSubscriptionRequests": ...,
}

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

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

Method definition
def batch_get_security_controls(
    self,
    *,
    SecurityControlIds: Sequence[str],
) -> BatchGetSecurityControlsResponseTypeDef:  # (1)
    ...
  1. See BatchGetSecurityControlsResponseTypeDef
Usage example with kwargs
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

Method definition
def batch_get_standards_control_associations(
    self,
    *,
    StandardsControlAssociationIds: Sequence[StandardsControlAssociationIdTypeDef],  # (1)
) -> BatchGetStandardsControlAssociationsResponseTypeDef:  # (2)
    ...
  1. See StandardsControlAssociationIdTypeDef
  2. See BatchGetStandardsControlAssociationsResponseTypeDef
Usage example with kwargs
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

Method definition
def batch_import_findings(
    self,
    *,
    Findings: Sequence[AwsSecurityFindingTypeDef],  # (1)
) -> BatchImportFindingsResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingTypeDef
  2. See BatchImportFindingsResponseTypeDef
Usage example with kwargs
kwargs: BatchImportFindingsRequestRequestTypeDef = {  # (1)
    "Findings": ...,
}

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

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

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
Usage example with kwargs
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

Method definition
def batch_update_standards_control_associations(
    self,
    *,
    StandardsControlAssociationUpdates: Sequence[StandardsControlAssociationUpdateTypeDef],  # (1)
) -> BatchUpdateStandardsControlAssociationsResponseTypeDef:  # (2)
    ...
  1. See StandardsControlAssociationUpdateTypeDef
  2. See BatchUpdateStandardsControlAssociationsResponseTypeDef
Usage example with kwargs
kwargs: BatchUpdateStandardsControlAssociationsRequestRequestTypeDef = {  # (1)
    "StandardsControlAssociationUpdates": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def create_action_target(
    self,
    *,
    Name: str,
    Description: str,
    Id: str,
) -> CreateActionTargetResponseTypeDef:  # (1)
    ...
  1. See CreateActionTargetResponseTypeDef
Usage example with kwargs
kwargs: CreateActionTargetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Description": ...,
    "Id": ...,
}

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

create_finding_aggregator

Used to enable finding aggregation.

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

Method definition
def create_finding_aggregator(
    self,
    *,
    RegionLinkingMode: str,
    Regions: Sequence[str] = ...,
) -> CreateFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See CreateFindingAggregatorResponseTypeDef
Usage example with kwargs
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

Method definition
def create_insight(
    self,
    *,
    Name: str,
    Filters: AwsSecurityFindingFiltersTypeDef,  # (1)
    GroupByAttribute: str,
) -> CreateInsightResponseTypeDef:  # (2)
    ...
  1. See AwsSecurityFindingFiltersTypeDef
  2. See CreateInsightResponseTypeDef
Usage example with kwargs
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

Method definition
def create_members(
    self,
    *,
    AccountDetails: Sequence[AccountDetailsTypeDef],  # (1)
) -> CreateMembersResponseTypeDef:  # (2)
    ...
  1. See AccountDetailsTypeDef
  2. See CreateMembersResponseTypeDef
Usage example with kwargs
kwargs: CreateMembersRequestRequestTypeDef = {  # (1)
    "AccountDetails": ...,
}

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

decline_invitations

Declines invitations to become a member account.

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

Method definition
def decline_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeclineInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeclineInvitationsResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_action_target(
    self,
    *,
    ActionTargetArn: str,
) -> DeleteActionTargetResponseTypeDef:  # (1)
    ...
  1. See DeleteActionTargetResponseTypeDef
Usage example with kwargs
kwargs: DeleteActionTargetRequestRequestTypeDef = {  # (1)
    "ActionTargetArn": ...,
}

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

delete_finding_aggregator

Deletes a finding aggregator.

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

Method definition
def delete_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def delete_insight(
    self,
    *,
    InsightArn: str,
) -> DeleteInsightResponseTypeDef:  # (1)
    ...
  1. See DeleteInsightResponseTypeDef
Usage example with kwargs
kwargs: DeleteInsightRequestRequestTypeDef = {  # (1)
    "InsightArn": ...,
}

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

delete_invitations

Deletes invitations received by the Amazon Web Services account to become a member account.

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

Method definition
def delete_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeleteInvitationsResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef:  # (1)
    ...
  1. See DeleteMembersResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_action_targets(
    self,
    *,
    ActionTargetArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeActionTargetsResponseTypeDef:  # (1)
    ...
  1. See DescribeActionTargetsResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_hub(
    self,
    *,
    HubArn: str = ...,
) -> DescribeHubResponseTypeDef:  # (1)
    ...
  1. See DescribeHubResponseTypeDef
Usage example with kwargs
kwargs: DescribeHubRequestRequestTypeDef = {  # (1)
    "HubArn": ...,
}

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

describe_organization_configuration

Returns information about the Organizations configuration for Security Hub.

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

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

Method definition
def describe_products(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ProductArn: str = ...,
) -> DescribeProductsResponseTypeDef:  # (1)
    ...
  1. See DescribeProductsResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_standards(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStandardsResponseTypeDef:  # (1)
    ...
  1. See DescribeStandardsResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_standards_controls(
    self,
    *,
    StandardsSubscriptionArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStandardsControlsResponseTypeDef:  # (1)
    ...
  1. See DescribeStandardsControlsResponseTypeDef
Usage example with kwargs
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

Method definition
def disable_import_findings_for_product(
    self,
    *,
    ProductSubscriptionArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def disable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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 Region.

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

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

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

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

Method definition
def disassociate_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def enable_import_findings_for_product(
    self,
    *,
    ProductArn: str,
) -> EnableImportFindingsForProductResponseTypeDef:  # (1)
    ...
  1. See EnableImportFindingsForProductResponseTypeDef
Usage example with kwargs
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

Method definition
def enable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def enable_security_hub(
    self,
    *,
    Tags: Mapping[str, str] = ...,
    EnableDefaultStandards: bool = ...,
    ControlFindingGenerator: ControlFindingGeneratorType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ControlFindingGeneratorType
Usage example with kwargs
kwargs: EnableSecurityHubRequestRequestTypeDef = {  # (1)
    "Tags": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

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

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

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

Method definition
def get_enabled_standards(
    self,
    *,
    StandardsSubscriptionArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetEnabledStandardsResponseTypeDef:  # (1)
    ...
  1. See GetEnabledStandardsResponseTypeDef
Usage example with kwargs
kwargs: GetEnabledStandardsRequestRequestTypeDef = {  # (1)
    "StandardsSubscriptionArns": ...,
}

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

get_finding_aggregator

Returns the current finding aggregation configuration.

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

Method definition
def get_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
) -> GetFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See GetFindingAggregatorResponseTypeDef
Usage example with kwargs
kwargs: GetFindingAggregatorRequestRequestTypeDef = {  # (1)
    "FindingAggregatorArn": ...,
}

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

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

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
Usage example with kwargs
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

Method definition
def get_insight_results(
    self,
    *,
    InsightArn: str,
) -> GetInsightResultsResponseTypeDef:  # (1)
    ...
  1. See GetInsightResultsResponseTypeDef
Usage example with kwargs
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

Method definition
def get_insights(
    self,
    *,
    InsightArns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetInsightsResponseTypeDef:  # (1)
    ...
  1. See GetInsightsResponseTypeDef
Usage example with kwargs
kwargs: GetInsightsRequestRequestTypeDef = {  # (1)
    "InsightArns": ...,
}

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

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.

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

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

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

Method definition
def get_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef:  # (1)
    ...
  1. See GetMembersResponseTypeDef
Usage example with kwargs
kwargs: GetMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

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

invite_members

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

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

Method definition
def invite_members(
    self,
    *,
    AccountIds: Sequence[str],
) -> InviteMembersResponseTypeDef:  # (1)
    ...
  1. See InviteMembersResponseTypeDef
Usage example with kwargs
kwargs: InviteMembersRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

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

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

Method definition
def list_enabled_products_for_import(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEnabledProductsForImportResponseTypeDef:  # (1)
    ...
  1. See ListEnabledProductsForImportResponseTypeDef
Usage example with kwargs
kwargs: ListEnabledProductsForImportRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

list_finding_aggregators

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator.

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

Method definition
def list_finding_aggregators(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFindingAggregatorsResponseTypeDef:  # (1)
    ...
  1. See ListFindingAggregatorsResponseTypeDef
Usage example with kwargs
kwargs: ListFindingAggregatorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

list_invitations

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

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

Method definition
def list_invitations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInvitationsResponseTypeDef:  # (1)
    ...
  1. See ListInvitationsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_members(
    self,
    *,
    OnlyAssociated: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...
  1. See ListMembersResponseTypeDef
Usage example with kwargs
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

Method definition
def list_organization_admin_accounts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationAdminAccountsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_security_control_definitions(
    self,
    *,
    StandardsArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSecurityControlDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListSecurityControlDefinitionsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_standards_control_associations(
    self,
    *,
    SecurityControlId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStandardsControlAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListStandardsControlAssociationsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

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

tag_resource

Adds one or more tags to a resource.

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def update_action_target(
    self,
    *,
    ActionTargetArn: str,
    Name: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateActionTargetRequestRequestTypeDef = {  # (1)
    "ActionTargetArn": ...,
}

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

update_finding_aggregator

Updates the finding aggregation configuration.

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

Method definition
def update_finding_aggregator(
    self,
    *,
    FindingAggregatorArn: str,
    RegionLinkingMode: str,
    Regions: Sequence[str] = ...,
) -> UpdateFindingAggregatorResponseTypeDef:  # (1)
    ...
  1. See UpdateFindingAggregatorResponseTypeDef
Usage example with kwargs
kwargs: UpdateFindingAggregatorRequestRequestTypeDef = {  # (1)
    "FindingAggregatorArn": ...,
    "RegionLinkingMode": ...,
}

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

update_findings

UpdateFindings is deprecated.

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

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
Usage example with kwargs
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

Method definition
def update_insight(
    self,
    *,
    InsightArn: str,
    Name: str = ...,
    Filters: AwsSecurityFindingFiltersTypeDef = ...,  # (1)
    GroupByAttribute: str = ...,
) -> Dict[str, Any]:
    ...
  1. See AwsSecurityFindingFiltersTypeDef
Usage example with kwargs
kwargs: UpdateInsightRequestRequestTypeDef = {  # (1)
    "InsightArn": ...,
}

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

update_organization_configuration

Used to update the configuration related to Organizations.

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

Method definition
def update_organization_configuration(
    self,
    *,
    AutoEnable: bool,
    AutoEnableStandards: AutoEnableStandardsType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AutoEnableStandardsType
Usage example with kwargs
kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "AutoEnable": ...,
}

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

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

Method definition
def update_security_hub_configuration(
    self,
    *,
    AutoEnableControls: bool = ...,
    ControlFindingGenerator: ControlFindingGeneratorType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ControlFindingGeneratorType
Usage example with kwargs
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

Method definition
def update_standards_control(
    self,
    *,
    StandardsControlArn: str,
    ControlStatus: ControlStatusType = ...,  # (1)
    DisabledReason: str = ...,
) -> Dict[str, Any]:
    ...
  1. See ControlStatusType
Usage example with kwargs
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.