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
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.
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)
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
def accept_administrator_invitation(
self,
*,
AdministratorId: str,
InvitationId: str,
) -> Dict[str, Any]:
...
kwargs: AcceptAdministratorInvitationRequestRequestTypeDef = { # (1)
"AdministratorId": ...,
"InvitationId": ...,
}
parent.accept_administrator_invitation(**kwargs)
accept_invitation
This method is deprecated.
Type annotations and code completion for boto3.client("securityhub").accept_invitation
method.
boto3 documentation
def accept_invitation(
self,
*,
MasterId: str,
InvitationId: str,
) -> Dict[str, Any]:
...
kwargs: AcceptInvitationRequestRequestTypeDef = { # (1)
"MasterId": ...,
"InvitationId": ...,
}
parent.accept_invitation(**kwargs)
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
def batch_disable_standards(
self,
*,
StandardsSubscriptionArns: Sequence[str],
) -> BatchDisableStandardsResponseTypeDef: # (1)
...
kwargs: BatchDisableStandardsRequestRequestTypeDef = { # (1)
"StandardsSubscriptionArns": ...,
}
parent.batch_disable_standards(**kwargs)
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
def batch_enable_standards(
self,
*,
StandardsSubscriptionRequests: Sequence[StandardsSubscriptionRequestTypeDef], # (1)
) -> BatchEnableStandardsResponseTypeDef: # (2)
...
kwargs: BatchEnableStandardsRequestRequestTypeDef = { # (1)
"StandardsSubscriptionRequests": ...,
}
parent.batch_enable_standards(**kwargs)
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
def batch_get_security_controls(
self,
*,
SecurityControlIds: Sequence[str],
) -> BatchGetSecurityControlsResponseTypeDef: # (1)
...
kwargs: BatchGetSecurityControlsRequestRequestTypeDef = { # (1)
"SecurityControlIds": ...,
}
parent.batch_get_security_controls(**kwargs)
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
def batch_get_standards_control_associations(
self,
*,
StandardsControlAssociationIds: Sequence[StandardsControlAssociationIdTypeDef], # (1)
) -> BatchGetStandardsControlAssociationsResponseTypeDef: # (2)
...
kwargs: BatchGetStandardsControlAssociationsRequestRequestTypeDef = { # (1)
"StandardsControlAssociationIds": ...,
}
parent.batch_get_standards_control_associations(**kwargs)
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
def batch_import_findings(
self,
*,
Findings: Sequence[AwsSecurityFindingTypeDef], # (1)
) -> BatchImportFindingsResponseTypeDef: # (2)
...
kwargs: BatchImportFindingsRequestRequestTypeDef = { # (1)
"Findings": ...,
}
parent.batch_import_findings(**kwargs)
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
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)
...
- See AwsSecurityFindingIdentifierTypeDef
- See NoteUpdateTypeDef
- See SeverityUpdateTypeDef
- See VerificationStateType
- See WorkflowUpdateTypeDef
- See RelatedFindingTypeDef
- See BatchUpdateFindingsResponseTypeDef
kwargs: BatchUpdateFindingsRequestRequestTypeDef = { # (1)
"FindingIdentifiers": ...,
}
parent.batch_update_findings(**kwargs)
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
def batch_update_standards_control_associations(
self,
*,
StandardsControlAssociationUpdates: Sequence[StandardsControlAssociationUpdateTypeDef], # (1)
) -> BatchUpdateStandardsControlAssociationsResponseTypeDef: # (2)
...
- See StandardsControlAssociationUpdateTypeDef
- See BatchUpdateStandardsControlAssociationsResponseTypeDef
kwargs: BatchUpdateStandardsControlAssociationsRequestRequestTypeDef = { # (1)
"StandardsControlAssociationUpdates": ...,
}
parent.batch_update_standards_control_associations(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("securityhub").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("securityhub").close
method.
boto3 documentation
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
def create_action_target(
self,
*,
Name: str,
Description: str,
Id: str,
) -> CreateActionTargetResponseTypeDef: # (1)
...
kwargs: CreateActionTargetRequestRequestTypeDef = { # (1)
"Name": ...,
"Description": ...,
"Id": ...,
}
parent.create_action_target(**kwargs)
create_finding_aggregator
Used to enable finding aggregation.
Type annotations and code completion for boto3.client("securityhub").create_finding_aggregator
method.
boto3 documentation
def create_finding_aggregator(
self,
*,
RegionLinkingMode: str,
Regions: Sequence[str] = ...,
) -> CreateFindingAggregatorResponseTypeDef: # (1)
...
kwargs: CreateFindingAggregatorRequestRequestTypeDef = { # (1)
"RegionLinkingMode": ...,
}
parent.create_finding_aggregator(**kwargs)
create_insight
Creates a custom insight in Security Hub.
Type annotations and code completion for boto3.client("securityhub").create_insight
method.
boto3 documentation
def create_insight(
self,
*,
Name: str,
Filters: AwsSecurityFindingFiltersTypeDef, # (1)
GroupByAttribute: str,
) -> CreateInsightResponseTypeDef: # (2)
...
kwargs: CreateInsightRequestRequestTypeDef = { # (1)
"Name": ...,
"Filters": ...,
"GroupByAttribute": ...,
}
parent.create_insight(**kwargs)
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
def create_members(
self,
*,
AccountDetails: Sequence[AccountDetailsTypeDef], # (1)
) -> CreateMembersResponseTypeDef: # (2)
...
kwargs: CreateMembersRequestRequestTypeDef = { # (1)
"AccountDetails": ...,
}
parent.create_members(**kwargs)
decline_invitations
Declines invitations to become a member account.
Type annotations and code completion for boto3.client("securityhub").decline_invitations
method.
boto3 documentation
def decline_invitations(
self,
*,
AccountIds: Sequence[str],
) -> DeclineInvitationsResponseTypeDef: # (1)
...
kwargs: DeclineInvitationsRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.decline_invitations(**kwargs)
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
def delete_action_target(
self,
*,
ActionTargetArn: str,
) -> DeleteActionTargetResponseTypeDef: # (1)
...
kwargs: DeleteActionTargetRequestRequestTypeDef = { # (1)
"ActionTargetArn": ...,
}
parent.delete_action_target(**kwargs)
delete_finding_aggregator
Deletes a finding aggregator.
Type annotations and code completion for boto3.client("securityhub").delete_finding_aggregator
method.
boto3 documentation
def delete_finding_aggregator(
self,
*,
FindingAggregatorArn: str,
) -> Dict[str, Any]:
...
kwargs: DeleteFindingAggregatorRequestRequestTypeDef = { # (1)
"FindingAggregatorArn": ...,
}
parent.delete_finding_aggregator(**kwargs)
delete_insight
Deletes the insight specified by the InsightArn
.
Type annotations and code completion for boto3.client("securityhub").delete_insight
method.
boto3 documentation
def delete_insight(
self,
*,
InsightArn: str,
) -> DeleteInsightResponseTypeDef: # (1)
...
kwargs: DeleteInsightRequestRequestTypeDef = { # (1)
"InsightArn": ...,
}
parent.delete_insight(**kwargs)
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
def delete_invitations(
self,
*,
AccountIds: Sequence[str],
) -> DeleteInvitationsResponseTypeDef: # (1)
...
kwargs: DeleteInvitationsRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.delete_invitations(**kwargs)
delete_members
Deletes the specified member accounts from Security Hub.
Type annotations and code completion for boto3.client("securityhub").delete_members
method.
boto3 documentation
def delete_members(
self,
*,
AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef: # (1)
...
kwargs: DeleteMembersRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.delete_members(**kwargs)
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
def describe_action_targets(
self,
*,
ActionTargetArns: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeActionTargetsResponseTypeDef: # (1)
...
kwargs: DescribeActionTargetsRequestRequestTypeDef = { # (1)
"ActionTargetArns": ...,
}
parent.describe_action_targets(**kwargs)
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
def describe_hub(
self,
*,
HubArn: str = ...,
) -> DescribeHubResponseTypeDef: # (1)
...
kwargs: DescribeHubRequestRequestTypeDef = { # (1)
"HubArn": ...,
}
parent.describe_hub(**kwargs)
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
def describe_organization_configuration(
self,
) -> DescribeOrganizationConfigurationResponseTypeDef: # (1)
...
describe_products
Returns information about product integrations in Security Hub.
Type annotations and code completion for boto3.client("securityhub").describe_products
method.
boto3 documentation
def describe_products(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ProductArn: str = ...,
) -> DescribeProductsResponseTypeDef: # (1)
...
kwargs: DescribeProductsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_products(**kwargs)
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
def describe_standards(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeStandardsResponseTypeDef: # (1)
...
kwargs: DescribeStandardsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_standards(**kwargs)
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
def describe_standards_controls(
self,
*,
StandardsSubscriptionArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeStandardsControlsResponseTypeDef: # (1)
...
kwargs: DescribeStandardsControlsRequestRequestTypeDef = { # (1)
"StandardsSubscriptionArn": ...,
}
parent.describe_standards_controls(**kwargs)
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
def disable_import_findings_for_product(
self,
*,
ProductSubscriptionArn: str,
) -> Dict[str, Any]:
...
kwargs: DisableImportFindingsForProductRequestRequestTypeDef = { # (1)
"ProductSubscriptionArn": ...,
}
parent.disable_import_findings_for_product(**kwargs)
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
def disable_organization_admin_account(
self,
*,
AdminAccountId: str,
) -> Dict[str, Any]:
...
kwargs: DisableOrganizationAdminAccountRequestRequestTypeDef = { # (1)
"AdminAccountId": ...,
}
parent.disable_organization_admin_account(**kwargs)
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
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_master_account
This method is deprecated.
Type annotations and code completion for boto3.client("securityhub").disassociate_from_master_account
method.
boto3 documentation
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
def disassociate_members(
self,
*,
AccountIds: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: DisassociateMembersRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.disassociate_members(**kwargs)
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
def enable_import_findings_for_product(
self,
*,
ProductArn: str,
) -> EnableImportFindingsForProductResponseTypeDef: # (1)
...
kwargs: EnableImportFindingsForProductRequestRequestTypeDef = { # (1)
"ProductArn": ...,
}
parent.enable_import_findings_for_product(**kwargs)
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
def enable_organization_admin_account(
self,
*,
AdminAccountId: str,
) -> Dict[str, Any]:
...
kwargs: EnableOrganizationAdminAccountRequestRequestTypeDef = { # (1)
"AdminAccountId": ...,
}
parent.enable_organization_admin_account(**kwargs)
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
def enable_security_hub(
self,
*,
Tags: Mapping[str, str] = ...,
EnableDefaultStandards: bool = ...,
ControlFindingGenerator: ControlFindingGeneratorType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: EnableSecurityHubRequestRequestTypeDef = { # (1)
"Tags": ...,
}
parent.enable_security_hub(**kwargs)
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
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
def get_administrator_account(
self,
) -> GetAdministratorAccountResponseTypeDef: # (1)
...
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
def get_enabled_standards(
self,
*,
StandardsSubscriptionArns: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetEnabledStandardsResponseTypeDef: # (1)
...
kwargs: GetEnabledStandardsRequestRequestTypeDef = { # (1)
"StandardsSubscriptionArns": ...,
}
parent.get_enabled_standards(**kwargs)
get_finding_aggregator
Returns the current finding aggregation configuration.
Type annotations and code completion for boto3.client("securityhub").get_finding_aggregator
method.
boto3 documentation
def get_finding_aggregator(
self,
*,
FindingAggregatorArn: str,
) -> GetFindingAggregatorResponseTypeDef: # (1)
...
kwargs: GetFindingAggregatorRequestRequestTypeDef = { # (1)
"FindingAggregatorArn": ...,
}
parent.get_finding_aggregator(**kwargs)
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
def get_findings(
self,
*,
Filters: AwsSecurityFindingFiltersTypeDef = ..., # (1)
SortCriteria: Sequence[SortCriterionTypeDef] = ..., # (2)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetFindingsResponseTypeDef: # (3)
...
kwargs: GetFindingsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.get_findings(**kwargs)
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
def get_insight_results(
self,
*,
InsightArn: str,
) -> GetInsightResultsResponseTypeDef: # (1)
...
kwargs: GetInsightResultsRequestRequestTypeDef = { # (1)
"InsightArn": ...,
}
parent.get_insight_results(**kwargs)
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
def get_insights(
self,
*,
InsightArns: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetInsightsResponseTypeDef: # (1)
...
kwargs: GetInsightsRequestRequestTypeDef = { # (1)
"InsightArns": ...,
}
parent.get_insights(**kwargs)
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
def get_invitations_count(
self,
) -> GetInvitationsCountResponseTypeDef: # (1)
...
get_master_account
This method is deprecated.
Type annotations and code completion for boto3.client("securityhub").get_master_account
method.
boto3 documentation
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
def get_members(
self,
*,
AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef: # (1)
...
kwargs: GetMembersRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.get_members(**kwargs)
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
def invite_members(
self,
*,
AccountIds: Sequence[str],
) -> InviteMembersResponseTypeDef: # (1)
...
kwargs: InviteMembersRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.invite_members(**kwargs)
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
def list_enabled_products_for_import(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEnabledProductsForImportResponseTypeDef: # (1)
...
kwargs: ListEnabledProductsForImportRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_enabled_products_for_import(**kwargs)
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
def list_finding_aggregators(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFindingAggregatorsResponseTypeDef: # (1)
...
kwargs: ListFindingAggregatorsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_finding_aggregators(**kwargs)
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
def list_invitations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInvitationsResponseTypeDef: # (1)
...
kwargs: ListInvitationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_invitations(**kwargs)
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
def list_members(
self,
*,
OnlyAssociated: bool = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMembersResponseTypeDef: # (1)
...
kwargs: ListMembersRequestRequestTypeDef = { # (1)
"OnlyAssociated": ...,
}
parent.list_members(**kwargs)
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
def list_organization_admin_accounts(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef: # (1)
...
kwargs: ListOrganizationAdminAccountsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_organization_admin_accounts(**kwargs)
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
def list_security_control_definitions(
self,
*,
StandardsArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityControlDefinitionsResponseTypeDef: # (1)
...
kwargs: ListSecurityControlDefinitionsRequestRequestTypeDef = { # (1)
"StandardsArn": ...,
}
parent.list_security_control_definitions(**kwargs)
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
def list_standards_control_associations(
self,
*,
SecurityControlId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListStandardsControlAssociationsResponseTypeDef: # (1)
...
kwargs: ListStandardsControlAssociationsRequestRequestTypeDef = { # (1)
"SecurityControlId": ...,
}
parent.list_standards_control_associations(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource
Adds one or more tags to a resource.
Type annotations and code completion for boto3.client("securityhub").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes one or more tags from a resource.
Type annotations and code completion for boto3.client("securityhub").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_action_target(
self,
*,
ActionTargetArn: str,
Name: str = ...,
Description: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateActionTargetRequestRequestTypeDef = { # (1)
"ActionTargetArn": ...,
}
parent.update_action_target(**kwargs)
update_finding_aggregator
Updates the finding aggregation configuration.
Type annotations and code completion for boto3.client("securityhub").update_finding_aggregator
method.
boto3 documentation
def update_finding_aggregator(
self,
*,
FindingAggregatorArn: str,
RegionLinkingMode: str,
Regions: Sequence[str] = ...,
) -> UpdateFindingAggregatorResponseTypeDef: # (1)
...
kwargs: UpdateFindingAggregatorRequestRequestTypeDef = { # (1)
"FindingAggregatorArn": ...,
"RegionLinkingMode": ...,
}
parent.update_finding_aggregator(**kwargs)
update_findings
UpdateFindings
is deprecated.
Type annotations and code completion for boto3.client("securityhub").update_findings
method.
boto3 documentation
def update_findings(
self,
*,
Filters: AwsSecurityFindingFiltersTypeDef, # (1)
Note: NoteUpdateTypeDef = ..., # (2)
RecordState: RecordStateType = ..., # (3)
) -> Dict[str, Any]:
...
kwargs: UpdateFindingsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.update_findings(**kwargs)
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
def update_insight(
self,
*,
InsightArn: str,
Name: str = ...,
Filters: AwsSecurityFindingFiltersTypeDef = ..., # (1)
GroupByAttribute: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateInsightRequestRequestTypeDef = { # (1)
"InsightArn": ...,
}
parent.update_insight(**kwargs)
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
def update_organization_configuration(
self,
*,
AutoEnable: bool,
AutoEnableStandards: AutoEnableStandardsType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = { # (1)
"AutoEnable": ...,
}
parent.update_organization_configuration(**kwargs)
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
def update_security_hub_configuration(
self,
*,
AutoEnableControls: bool = ...,
ControlFindingGenerator: ControlFindingGeneratorType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateSecurityHubConfigurationRequestRequestTypeDef = { # (1)
"AutoEnableControls": ...,
}
parent.update_security_hub_configuration(**kwargs)
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
def update_standards_control(
self,
*,
StandardsControlArn: str,
ControlStatus: ControlStatusType = ..., # (1)
DisabledReason: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateStandardsControlRequestRequestTypeDef = { # (1)
"StandardsControlArn": ...,
}
parent.update_standards_control(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("securityhub").get_paginator
method with overloads.
client.get_paginator("describe_action_targets")
-> DescribeActionTargetsPaginatorclient.get_paginator("describe_products")
-> DescribeProductsPaginatorclient.get_paginator("describe_standards")
-> DescribeStandardsPaginatorclient.get_paginator("describe_standards_controls")
-> DescribeStandardsControlsPaginatorclient.get_paginator("get_enabled_standards")
-> GetEnabledStandardsPaginatorclient.get_paginator("get_findings")
-> GetFindingsPaginatorclient.get_paginator("get_insights")
-> GetInsightsPaginatorclient.get_paginator("list_enabled_products_for_import")
-> ListEnabledProductsForImportPaginatorclient.get_paginator("list_finding_aggregators")
-> ListFindingAggregatorsPaginatorclient.get_paginator("list_invitations")
-> ListInvitationsPaginatorclient.get_paginator("list_members")
-> ListMembersPaginatorclient.get_paginator("list_organization_admin_accounts")
-> ListOrganizationAdminAccountsPaginatorclient.get_paginator("list_security_control_definitions")
-> ListSecurityControlDefinitionsPaginatorclient.get_paginator("list_standards_control_associations")
-> ListStandardsControlAssociationsPaginator