Skip to content

Macie2Client#

Index > Macie2 > Macie2Client

Auto-generated documentation for Macie2 type annotations stubs module mypy-boto3-macie2.

Macie2Client#

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

# Macie2Client usage example

from boto3.session import Session
from mypy_boto3_macie2.client import Macie2Client

def get_macie2_client() -> Macie2Client:
    return Session().client("macie2")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("macie2")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnprocessableEntityException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_macie2.client import Exceptions

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

Methods#

accept_invitation#

Accepts an Amazon Macie membership invitation that was received from a specific account.

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

# accept_invitation method definition

def accept_invitation(
    self,
    *,
    invitationId: str,
    administratorAccountId: str = ...,
    masterAccount: str = ...,
) -> Dict[str, Any]:
    ...
# accept_invitation method usage example with argument unpacking

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

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

batch_get_custom_data_identifiers#

Retrieves information about one or more custom data identifiers.

Type annotations and code completion for boto3.client("macie2").batch_get_custom_data_identifiers method. boto3 documentation

# batch_get_custom_data_identifiers method definition

def batch_get_custom_data_identifiers(
    self,
    *,
    ids: Sequence[str] = ...,
) -> BatchGetCustomDataIdentifiersResponseTypeDef:  # (1)
    ...
  1. See BatchGetCustomDataIdentifiersResponseTypeDef 
# batch_get_custom_data_identifiers method usage example with argument unpacking

kwargs: BatchGetCustomDataIdentifiersRequestRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_custom_data_identifiers(**kwargs)
  1. See BatchGetCustomDataIdentifiersRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_allow_list#

Creates and defines the settings for an allow list.

Type annotations and code completion for boto3.client("macie2").create_allow_list method. boto3 documentation

# create_allow_list method definition

def create_allow_list(
    self,
    *,
    clientToken: str,
    criteria: AllowListCriteriaTypeDef,  # (1)
    name: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAllowListResponseTypeDef:  # (2)
    ...
  1. See AllowListCriteriaTypeDef
  2. See CreateAllowListResponseTypeDef 
# create_allow_list method usage example with argument unpacking

kwargs: CreateAllowListRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "criteria": ...,
    "name": ...,
}

parent.create_allow_list(**kwargs)
  1. See CreateAllowListRequestRequestTypeDef

create_classification_job#

Creates and defines the settings for a classification job.

Type annotations and code completion for boto3.client("macie2").create_classification_job method. boto3 documentation

# create_classification_job method definition

def create_classification_job(
    self,
    *,
    clientToken: str,
    jobType: JobTypeType,  # (1)
    name: str,
    s3JobDefinition: S3JobDefinitionTypeDef,  # (2)
    allowListIds: Sequence[str] = ...,
    customDataIdentifierIds: Sequence[str] = ...,
    description: str = ...,
    initialRun: bool = ...,
    managedDataIdentifierIds: Sequence[str] = ...,
    managedDataIdentifierSelector: ManagedDataIdentifierSelectorType = ...,  # (3)
    samplingPercentage: int = ...,
    scheduleFrequency: JobScheduleFrequencyTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateClassificationJobResponseTypeDef:  # (5)
    ...
  1. See JobTypeType
  2. See S3JobDefinitionTypeDef
  3. See ManagedDataIdentifierSelectorType
  4. See JobScheduleFrequencyTypeDef
  5. See CreateClassificationJobResponseTypeDef 
# create_classification_job method usage example with argument unpacking

kwargs: CreateClassificationJobRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "jobType": ...,
    "name": ...,
    "s3JobDefinition": ...,
}

parent.create_classification_job(**kwargs)
  1. See CreateClassificationJobRequestRequestTypeDef

create_custom_data_identifier#

Creates and defines the criteria and other settings for a custom data identifier.

Type annotations and code completion for boto3.client("macie2").create_custom_data_identifier method. boto3 documentation

# create_custom_data_identifier method definition

def create_custom_data_identifier(
    self,
    *,
    name: str,
    regex: str,
    clientToken: str = ...,
    description: str = ...,
    ignoreWords: Sequence[str] = ...,
    keywords: Sequence[str] = ...,
    maximumMatchDistance: int = ...,
    severityLevels: Sequence[SeverityLevelTypeDef] = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateCustomDataIdentifierResponseTypeDef:  # (2)
    ...
  1. See SeverityLevelTypeDef
  2. See CreateCustomDataIdentifierResponseTypeDef 
# create_custom_data_identifier method usage example with argument unpacking

kwargs: CreateCustomDataIdentifierRequestRequestTypeDef = {  # (1)
    "name": ...,
    "regex": ...,
}

parent.create_custom_data_identifier(**kwargs)
  1. See CreateCustomDataIdentifierRequestRequestTypeDef

create_findings_filter#

Creates and defines the criteria and other settings for a findings filter.

Type annotations and code completion for boto3.client("macie2").create_findings_filter method. boto3 documentation

# create_findings_filter method definition

def create_findings_filter(
    self,
    *,
    action: FindingsFilterActionType,  # (1)
    findingCriteria: FindingCriteriaTypeDef,  # (2)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    position: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFindingsFilterResponseTypeDef:  # (3)
    ...
  1. See FindingsFilterActionType
  2. See FindingCriteriaTypeDef
  3. See CreateFindingsFilterResponseTypeDef 
# create_findings_filter method usage example with argument unpacking

kwargs: CreateFindingsFilterRequestRequestTypeDef = {  # (1)
    "action": ...,
    "findingCriteria": ...,
    "name": ...,
}

parent.create_findings_filter(**kwargs)
  1. See CreateFindingsFilterRequestRequestTypeDef

create_invitations#

Sends an Amazon Macie membership invitation to one or more accounts.

Type annotations and code completion for boto3.client("macie2").create_invitations method. boto3 documentation

# create_invitations method definition

def create_invitations(
    self,
    *,
    accountIds: Sequence[str],
    disableEmailNotification: bool = ...,
    message: str = ...,
) -> CreateInvitationsResponseTypeDef:  # (1)
    ...
  1. See CreateInvitationsResponseTypeDef 
# create_invitations method usage example with argument unpacking

kwargs: CreateInvitationsRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.create_invitations(**kwargs)
  1. See CreateInvitationsRequestRequestTypeDef

create_member#

Associates an account with an Amazon Macie administrator account.

Type annotations and code completion for boto3.client("macie2").create_member method. boto3 documentation

# create_member method definition

def create_member(
    self,
    *,
    account: AccountDetailTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateMemberResponseTypeDef:  # (2)
    ...
  1. See AccountDetailTypeDef
  2. See CreateMemberResponseTypeDef 
# create_member method usage example with argument unpacking

kwargs: CreateMemberRequestRequestTypeDef = {  # (1)
    "account": ...,
}

parent.create_member(**kwargs)
  1. See CreateMemberRequestRequestTypeDef

create_sample_findings#

Creates sample findings.

Type annotations and code completion for boto3.client("macie2").create_sample_findings method. boto3 documentation

# create_sample_findings method definition

def create_sample_findings(
    self,
    *,
    findingTypes: Sequence[FindingTypeType] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See FindingTypeType 
# create_sample_findings method usage example with argument unpacking

kwargs: CreateSampleFindingsRequestRequestTypeDef = {  # (1)
    "findingTypes": ...,
}

parent.create_sample_findings(**kwargs)
  1. See CreateSampleFindingsRequestRequestTypeDef

decline_invitations#

Declines Amazon Macie membership invitations that were received from specific accounts.

Type annotations and code completion for boto3.client("macie2").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_allow_list#

Deletes an allow list.

Type annotations and code completion for boto3.client("macie2").delete_allow_list method. boto3 documentation

# delete_allow_list method definition

def delete_allow_list(
    self,
    *,
    id: str,
    ignoreJobChecks: str = ...,
) -> Dict[str, Any]:
    ...
# delete_allow_list method usage example with argument unpacking

kwargs: DeleteAllowListRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_allow_list(**kwargs)
  1. See DeleteAllowListRequestRequestTypeDef

delete_custom_data_identifier#

Soft deletes a custom data identifier.

Type annotations and code completion for boto3.client("macie2").delete_custom_data_identifier method. boto3 documentation

# delete_custom_data_identifier method definition

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

kwargs: DeleteCustomDataIdentifierRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_custom_data_identifier(**kwargs)
  1. See DeleteCustomDataIdentifierRequestRequestTypeDef

delete_findings_filter#

Deletes a findings filter.

Type annotations and code completion for boto3.client("macie2").delete_findings_filter method. boto3 documentation

# delete_findings_filter method definition

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

kwargs: DeleteFindingsFilterRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_findings_filter(**kwargs)
  1. See DeleteFindingsFilterRequestRequestTypeDef

delete_invitations#

Deletes Amazon Macie membership invitations that were received from specific accounts.

Type annotations and code completion for boto3.client("macie2").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_member#

Deletes the association between an Amazon Macie administrator account and an account.

Type annotations and code completion for boto3.client("macie2").delete_member method. boto3 documentation

# delete_member method definition

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

kwargs: DeleteMemberRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_member(**kwargs)
  1. See DeleteMemberRequestRequestTypeDef

describe_buckets#

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

Type annotations and code completion for boto3.client("macie2").describe_buckets method. boto3 documentation

# describe_buckets method definition

def describe_buckets(
    self,
    *,
    criteria: Mapping[str, BucketCriteriaAdditionalPropertiesTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortCriteria: BucketSortCriteriaTypeDef = ...,  # (2)
) -> DescribeBucketsResponseTypeDef:  # (3)
    ...
  1. See BucketCriteriaAdditionalPropertiesTypeDef
  2. See BucketSortCriteriaTypeDef
  3. See DescribeBucketsResponseTypeDef 
# describe_buckets method usage example with argument unpacking

kwargs: DescribeBucketsRequestRequestTypeDef = {  # (1)
    "criteria": ...,
}

parent.describe_buckets(**kwargs)
  1. See DescribeBucketsRequestRequestTypeDef

describe_classification_job#

Retrieves the status and settings for a classification job.

Type annotations and code completion for boto3.client("macie2").describe_classification_job method. boto3 documentation

# describe_classification_job method definition

def describe_classification_job(
    self,
    *,
    jobId: str,
) -> DescribeClassificationJobResponseTypeDef:  # (1)
    ...
  1. See DescribeClassificationJobResponseTypeDef 
# describe_classification_job method usage example with argument unpacking

kwargs: DescribeClassificationJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_classification_job(**kwargs)
  1. See DescribeClassificationJobRequestRequestTypeDef

describe_organization_configuration#

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

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

# describe_organization_configuration method definition

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

disable_macie#

Disables Amazon Macie and deletes all settings and resources for a Macie account.

Type annotations and code completion for boto3.client("macie2").disable_macie method. boto3 documentation

# disable_macie method definition

def disable_macie(
    self,
) -> Dict[str, Any]:
    ...

disable_organization_admin_account#

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

Type annotations and code completion for boto3.client("macie2").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

disassociate_from_administrator_account#

Disassociates a member account from its Amazon Macie administrator account.

Type annotations and code completion for boto3.client("macie2").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#

(Deprecated) Disassociates a member account from its Amazon Macie administrator account.

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

# disassociate_from_master_account method definition

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

disassociate_member#

Disassociates an Amazon Macie administrator account from a member account.

Type annotations and code completion for boto3.client("macie2").disassociate_member method. boto3 documentation

# disassociate_member method definition

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

kwargs: DisassociateMemberRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.disassociate_member(**kwargs)
  1. See DisassociateMemberRequestRequestTypeDef

enable_macie#

Enables Amazon Macie and specifies the configuration settings for a Macie account.

Type annotations and code completion for boto3.client("macie2").enable_macie method. boto3 documentation

# enable_macie method definition

def enable_macie(
    self,
    *,
    clientToken: str = ...,
    findingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    status: MacieStatusType = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See FindingPublishingFrequencyType
  2. See MacieStatusType 
# enable_macie method usage example with argument unpacking

kwargs: EnableMacieRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
}

parent.enable_macie(**kwargs)
  1. See EnableMacieRequestRequestTypeDef

enable_organization_admin_account#

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

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

# enable_organization_admin_account method definition

def enable_organization_admin_account(
    self,
    *,
    adminAccountId: str,
    clientToken: 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

generate_presigned_url#

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

Type annotations and code completion for boto3.client("macie2").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:
    ...

get_administrator_account#

Retrieves information about the Amazon Macie administrator account for an account.

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

# get_administrator_account method definition

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

get_allow_list#

Retrieves the settings and status of an allow list.

Type annotations and code completion for boto3.client("macie2").get_allow_list method. boto3 documentation

# get_allow_list method definition

def get_allow_list(
    self,
    *,
    id: str,
) -> GetAllowListResponseTypeDef:  # (1)
    ...
  1. See GetAllowListResponseTypeDef 
# get_allow_list method usage example with argument unpacking

kwargs: GetAllowListRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_allow_list(**kwargs)
  1. See GetAllowListRequestRequestTypeDef

get_automated_discovery_configuration#

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

Type annotations and code completion for boto3.client("macie2").get_automated_discovery_configuration method. boto3 documentation

# get_automated_discovery_configuration method definition

def get_automated_discovery_configuration(
    self,
) -> GetAutomatedDiscoveryConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetAutomatedDiscoveryConfigurationResponseTypeDef

get_bucket_statistics#

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.

Type annotations and code completion for boto3.client("macie2").get_bucket_statistics method. boto3 documentation

# get_bucket_statistics method definition

def get_bucket_statistics(
    self,
    *,
    accountId: str = ...,
) -> GetBucketStatisticsResponseTypeDef:  # (1)
    ...
  1. See GetBucketStatisticsResponseTypeDef 
# get_bucket_statistics method usage example with argument unpacking

kwargs: GetBucketStatisticsRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.get_bucket_statistics(**kwargs)
  1. See GetBucketStatisticsRequestRequestTypeDef

get_classification_export_configuration#

Retrieves the configuration settings for storing data classification results.

Type annotations and code completion for boto3.client("macie2").get_classification_export_configuration method. boto3 documentation

# get_classification_export_configuration method definition

def get_classification_export_configuration(
    self,
) -> GetClassificationExportConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetClassificationExportConfigurationResponseTypeDef

get_classification_scope#

Retrieves the classification scope settings for an account.

Type annotations and code completion for boto3.client("macie2").get_classification_scope method. boto3 documentation

# get_classification_scope method definition

def get_classification_scope(
    self,
    *,
    id: str,
) -> GetClassificationScopeResponseTypeDef:  # (1)
    ...
  1. See GetClassificationScopeResponseTypeDef 
# get_classification_scope method usage example with argument unpacking

kwargs: GetClassificationScopeRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_classification_scope(**kwargs)
  1. See GetClassificationScopeRequestRequestTypeDef

get_custom_data_identifier#

Retrieves the criteria and other settings for a custom data identifier.

Type annotations and code completion for boto3.client("macie2").get_custom_data_identifier method. boto3 documentation

# get_custom_data_identifier method definition

def get_custom_data_identifier(
    self,
    *,
    id: str,
) -> GetCustomDataIdentifierResponseTypeDef:  # (1)
    ...
  1. See GetCustomDataIdentifierResponseTypeDef 
# get_custom_data_identifier method usage example with argument unpacking

kwargs: GetCustomDataIdentifierRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_custom_data_identifier(**kwargs)
  1. See GetCustomDataIdentifierRequestRequestTypeDef

get_finding_statistics#

Retrieves (queries) aggregated statistical data about findings.

Type annotations and code completion for boto3.client("macie2").get_finding_statistics method. boto3 documentation

# get_finding_statistics method definition

def get_finding_statistics(
    self,
    *,
    groupBy: GroupByType,  # (1)
    findingCriteria: FindingCriteriaTypeDef = ...,  # (2)
    size: int = ...,
    sortCriteria: FindingStatisticsSortCriteriaTypeDef = ...,  # (3)
) -> GetFindingStatisticsResponseTypeDef:  # (4)
    ...
  1. See GroupByType
  2. See FindingCriteriaTypeDef
  3. See FindingStatisticsSortCriteriaTypeDef
  4. See GetFindingStatisticsResponseTypeDef 
# get_finding_statistics method usage example with argument unpacking

kwargs: GetFindingStatisticsRequestRequestTypeDef = {  # (1)
    "groupBy": ...,
}

parent.get_finding_statistics(**kwargs)
  1. See GetFindingStatisticsRequestRequestTypeDef

get_findings#

Retrieves the details of one or more findings.

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

# get_findings method definition

def get_findings(
    self,
    *,
    findingIds: Sequence[str],
    sortCriteria: SortCriteriaTypeDef = ...,  # (1)
) -> GetFindingsResponseTypeDef:  # (2)
    ...
  1. See SortCriteriaTypeDef
  2. See GetFindingsResponseTypeDef 
# get_findings method usage example with argument unpacking

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

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

get_findings_filter#

Retrieves the criteria and other settings for a findings filter.

Type annotations and code completion for boto3.client("macie2").get_findings_filter method. boto3 documentation

# get_findings_filter method definition

def get_findings_filter(
    self,
    *,
    id: str,
) -> GetFindingsFilterResponseTypeDef:  # (1)
    ...
  1. See GetFindingsFilterResponseTypeDef 
# get_findings_filter method usage example with argument unpacking

kwargs: GetFindingsFilterRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_findings_filter(**kwargs)
  1. See GetFindingsFilterRequestRequestTypeDef

get_findings_publication_configuration#

Retrieves the configuration settings for publishing findings to Security Hub.

Type annotations and code completion for boto3.client("macie2").get_findings_publication_configuration method. boto3 documentation

# get_findings_publication_configuration method definition

def get_findings_publication_configuration(
    self,
) -> GetFindingsPublicationConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetFindingsPublicationConfigurationResponseTypeDef

get_invitations_count#

Retrieves the count of Amazon Macie membership invitations that were received by an account.

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

# get_invitations_count method definition

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

get_macie_session#

Retrieves the status and configuration settings for an Amazon Macie account.

Type annotations and code completion for boto3.client("macie2").get_macie_session method. boto3 documentation

# get_macie_session method definition

def get_macie_session(
    self,
) -> GetMacieSessionResponseTypeDef:  # (1)
    ...
  1. See GetMacieSessionResponseTypeDef

get_master_account#

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account.

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

# get_master_account method definition

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

get_member#

Retrieves information about an account that's associated with an Amazon Macie administrator account.

Type annotations and code completion for boto3.client("macie2").get_member method. boto3 documentation

# get_member method definition

def get_member(
    self,
    *,
    id: str,
) -> GetMemberResponseTypeDef:  # (1)
    ...
  1. See GetMemberResponseTypeDef 
# get_member method usage example with argument unpacking

kwargs: GetMemberRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_member(**kwargs)
  1. See GetMemberRequestRequestTypeDef

get_resource_profile#

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.

Type annotations and code completion for boto3.client("macie2").get_resource_profile method. boto3 documentation

# get_resource_profile method definition

def get_resource_profile(
    self,
    *,
    resourceArn: str,
) -> GetResourceProfileResponseTypeDef:  # (1)
    ...
  1. See GetResourceProfileResponseTypeDef 
# get_resource_profile method usage example with argument unpacking

kwargs: GetResourceProfileRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.get_resource_profile(**kwargs)
  1. See GetResourceProfileRequestRequestTypeDef

get_reveal_configuration#

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

Type annotations and code completion for boto3.client("macie2").get_reveal_configuration method. boto3 documentation

# get_reveal_configuration method definition

def get_reveal_configuration(
    self,
) -> GetRevealConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetRevealConfigurationResponseTypeDef

get_sensitive_data_occurrences#

Retrieves occurrences of sensitive data reported by a finding.

Type annotations and code completion for boto3.client("macie2").get_sensitive_data_occurrences method. boto3 documentation

# get_sensitive_data_occurrences method definition

def get_sensitive_data_occurrences(
    self,
    *,
    findingId: str,
) -> GetSensitiveDataOccurrencesResponseTypeDef:  # (1)
    ...
  1. See GetSensitiveDataOccurrencesResponseTypeDef 
# get_sensitive_data_occurrences method usage example with argument unpacking

kwargs: GetSensitiveDataOccurrencesRequestRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.get_sensitive_data_occurrences(**kwargs)
  1. See GetSensitiveDataOccurrencesRequestRequestTypeDef

get_sensitive_data_occurrences_availability#

Checks whether occurrences of sensitive data can be retrieved for a finding.

Type annotations and code completion for boto3.client("macie2").get_sensitive_data_occurrences_availability method. boto3 documentation

# get_sensitive_data_occurrences_availability method definition

def get_sensitive_data_occurrences_availability(
    self,
    *,
    findingId: str,
) -> GetSensitiveDataOccurrencesAvailabilityResponseTypeDef:  # (1)
    ...
  1. See GetSensitiveDataOccurrencesAvailabilityResponseTypeDef 
# get_sensitive_data_occurrences_availability method usage example with argument unpacking

kwargs: GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.get_sensitive_data_occurrences_availability(**kwargs)
  1. See GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef

get_sensitivity_inspection_template#

Retrieves the settings for the sensitivity inspection template for an account.

Type annotations and code completion for boto3.client("macie2").get_sensitivity_inspection_template method. boto3 documentation

# get_sensitivity_inspection_template method definition

def get_sensitivity_inspection_template(
    self,
    *,
    id: str,
) -> GetSensitivityInspectionTemplateResponseTypeDef:  # (1)
    ...
  1. See GetSensitivityInspectionTemplateResponseTypeDef 
# get_sensitivity_inspection_template method usage example with argument unpacking

kwargs: GetSensitivityInspectionTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_sensitivity_inspection_template(**kwargs)
  1. See GetSensitivityInspectionTemplateRequestRequestTypeDef

get_usage_statistics#

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

Type annotations and code completion for boto3.client("macie2").get_usage_statistics method. boto3 documentation

# get_usage_statistics method definition

def get_usage_statistics(
    self,
    *,
    filterBy: Sequence[UsageStatisticsFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortBy: UsageStatisticsSortByTypeDef = ...,  # (2)
    timeRange: TimeRangeType = ...,  # (3)
) -> GetUsageStatisticsResponseTypeDef:  # (4)
    ...
  1. See UsageStatisticsFilterTypeDef
  2. See UsageStatisticsSortByTypeDef
  3. See TimeRangeType
  4. See GetUsageStatisticsResponseTypeDef 
# get_usage_statistics method usage example with argument unpacking

kwargs: GetUsageStatisticsRequestRequestTypeDef = {  # (1)
    "filterBy": ...,
}

parent.get_usage_statistics(**kwargs)
  1. See GetUsageStatisticsRequestRequestTypeDef

get_usage_totals#

Retrieves (queries) aggregated usage data for an account.

Type annotations and code completion for boto3.client("macie2").get_usage_totals method. boto3 documentation

# get_usage_totals method definition

def get_usage_totals(
    self,
    *,
    timeRange: str = ...,
) -> GetUsageTotalsResponseTypeDef:  # (1)
    ...
  1. See GetUsageTotalsResponseTypeDef 
# get_usage_totals method usage example with argument unpacking

kwargs: GetUsageTotalsRequestRequestTypeDef = {  # (1)
    "timeRange": ...,
}

parent.get_usage_totals(**kwargs)
  1. See GetUsageTotalsRequestRequestTypeDef

list_allow_lists#

Retrieves a subset of information about all the allow lists for an account.

Type annotations and code completion for boto3.client("macie2").list_allow_lists method. boto3 documentation

# list_allow_lists method definition

def list_allow_lists(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAllowListsResponseTypeDef:  # (1)
    ...
  1. See ListAllowListsResponseTypeDef 
# list_allow_lists method usage example with argument unpacking

kwargs: ListAllowListsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_allow_lists(**kwargs)
  1. See ListAllowListsRequestRequestTypeDef

list_classification_jobs#

Retrieves a subset of information about one or more classification jobs.

Type annotations and code completion for boto3.client("macie2").list_classification_jobs method. boto3 documentation

# list_classification_jobs method definition

def list_classification_jobs(
    self,
    *,
    filterCriteria: ListJobsFilterCriteriaTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortCriteria: ListJobsSortCriteriaTypeDef = ...,  # (2)
) -> ListClassificationJobsResponseTypeDef:  # (3)
    ...
  1. See ListJobsFilterCriteriaTypeDef
  2. See ListJobsSortCriteriaTypeDef
  3. See ListClassificationJobsResponseTypeDef 
# list_classification_jobs method usage example with argument unpacking

kwargs: ListClassificationJobsRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.list_classification_jobs(**kwargs)
  1. See ListClassificationJobsRequestRequestTypeDef

list_classification_scopes#

Retrieves a subset of information about the classification scope for an account.

Type annotations and code completion for boto3.client("macie2").list_classification_scopes method. boto3 documentation

# list_classification_scopes method definition

def list_classification_scopes(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
) -> ListClassificationScopesResponseTypeDef:  # (1)
    ...
  1. See ListClassificationScopesResponseTypeDef 
# list_classification_scopes method usage example with argument unpacking

kwargs: ListClassificationScopesRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.list_classification_scopes(**kwargs)
  1. See ListClassificationScopesRequestRequestTypeDef

list_custom_data_identifiers#

Retrieves a subset of information about all the custom data identifiers for an account.

Type annotations and code completion for boto3.client("macie2").list_custom_data_identifiers method. boto3 documentation

# list_custom_data_identifiers method definition

def list_custom_data_identifiers(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomDataIdentifiersResponseTypeDef:  # (1)
    ...
  1. See ListCustomDataIdentifiersResponseTypeDef 
# list_custom_data_identifiers method usage example with argument unpacking

kwargs: ListCustomDataIdentifiersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_custom_data_identifiers(**kwargs)
  1. See ListCustomDataIdentifiersRequestRequestTypeDef

list_findings#

Retrieves a subset of information about one or more findings.

Type annotations and code completion for boto3.client("macie2").list_findings method. boto3 documentation

# list_findings method definition

def list_findings(
    self,
    *,
    findingCriteria: FindingCriteriaTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortCriteria: SortCriteriaTypeDef = ...,  # (2)
) -> ListFindingsResponseTypeDef:  # (3)
    ...
  1. See FindingCriteriaTypeDef
  2. See SortCriteriaTypeDef
  3. See ListFindingsResponseTypeDef 
# list_findings method usage example with argument unpacking

kwargs: ListFindingsRequestRequestTypeDef = {  # (1)
    "findingCriteria": ...,
}

parent.list_findings(**kwargs)
  1. See ListFindingsRequestRequestTypeDef

list_findings_filters#

Retrieves a subset of information about all the findings filters for an account.

Type annotations and code completion for boto3.client("macie2").list_findings_filters method. boto3 documentation

# list_findings_filters method definition

def list_findings_filters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFindingsFiltersResponseTypeDef:  # (1)
    ...
  1. See ListFindingsFiltersResponseTypeDef 
# list_findings_filters method usage example with argument unpacking

kwargs: ListFindingsFiltersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_findings_filters(**kwargs)
  1. See ListFindingsFiltersRequestRequestTypeDef

list_invitations#

Retrieves information about the Amazon Macie membership invitations that were received by an account.

Type annotations and code completion for boto3.client("macie2").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_managed_data_identifiers#

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

Type annotations and code completion for boto3.client("macie2").list_managed_data_identifiers method. boto3 documentation

# list_managed_data_identifiers method definition

def list_managed_data_identifiers(
    self,
    *,
    nextToken: str = ...,
) -> ListManagedDataIdentifiersResponseTypeDef:  # (1)
    ...
  1. See ListManagedDataIdentifiersResponseTypeDef 
# list_managed_data_identifiers method usage example with argument unpacking

kwargs: ListManagedDataIdentifiersRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_managed_data_identifiers(**kwargs)
  1. See ListManagedDataIdentifiersRequestRequestTypeDef

list_members#

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

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

# list_members method definition

def list_members(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    onlyAssociated: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...
  1. See ListMembersResponseTypeDef 
# list_members method usage example with argument unpacking

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

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

list_organization_admin_accounts#

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

Type annotations and code completion for boto3.client("macie2").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_resource_profile_artifacts#

Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.

Type annotations and code completion for boto3.client("macie2").list_resource_profile_artifacts method. boto3 documentation

# list_resource_profile_artifacts method definition

def list_resource_profile_artifacts(
    self,
    *,
    resourceArn: str,
    nextToken: str = ...,
) -> ListResourceProfileArtifactsResponseTypeDef:  # (1)
    ...
  1. See ListResourceProfileArtifactsResponseTypeDef 
# list_resource_profile_artifacts method usage example with argument unpacking

kwargs: ListResourceProfileArtifactsRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_resource_profile_artifacts(**kwargs)
  1. See ListResourceProfileArtifactsRequestRequestTypeDef

list_resource_profile_detections#

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

Type annotations and code completion for boto3.client("macie2").list_resource_profile_detections method. boto3 documentation

# list_resource_profile_detections method definition

def list_resource_profile_detections(
    self,
    *,
    resourceArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResourceProfileDetectionsResponseTypeDef:  # (1)
    ...
  1. See ListResourceProfileDetectionsResponseTypeDef 
# list_resource_profile_detections method usage example with argument unpacking

kwargs: ListResourceProfileDetectionsRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_resource_profile_detections(**kwargs)
  1. See ListResourceProfileDetectionsRequestRequestTypeDef

list_sensitivity_inspection_templates#

Retrieves a subset of information about the sensitivity inspection template for an account.

Type annotations and code completion for boto3.client("macie2").list_sensitivity_inspection_templates method. boto3 documentation

# list_sensitivity_inspection_templates method definition

def list_sensitivity_inspection_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSensitivityInspectionTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListSensitivityInspectionTemplatesResponseTypeDef 
# list_sensitivity_inspection_templates method usage example with argument unpacking

kwargs: ListSensitivityInspectionTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_sensitivity_inspection_templates(**kwargs)
  1. See ListSensitivityInspectionTemplatesRequestRequestTypeDef

list_tags_for_resource#

Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.

Type annotations and code completion for boto3.client("macie2").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

put_classification_export_configuration#

Creates or updates the configuration settings for storing data classification results.

Type annotations and code completion for boto3.client("macie2").put_classification_export_configuration method. boto3 documentation

# put_classification_export_configuration method definition

def put_classification_export_configuration(
    self,
    *,
    configuration: ClassificationExportConfigurationTypeDef,  # (1)
) -> PutClassificationExportConfigurationResponseTypeDef:  # (2)
    ...
  1. See ClassificationExportConfigurationTypeDef
  2. See PutClassificationExportConfigurationResponseTypeDef 
# put_classification_export_configuration method usage example with argument unpacking

kwargs: PutClassificationExportConfigurationRequestRequestTypeDef = {  # (1)
    "configuration": ...,
}

parent.put_classification_export_configuration(**kwargs)
  1. See PutClassificationExportConfigurationRequestRequestTypeDef

put_findings_publication_configuration#

Updates the configuration settings for publishing findings to Security Hub.

Type annotations and code completion for boto3.client("macie2").put_findings_publication_configuration method. boto3 documentation

# put_findings_publication_configuration method definition

def put_findings_publication_configuration(
    self,
    *,
    clientToken: str = ...,
    securityHubConfiguration: SecurityHubConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See SecurityHubConfigurationTypeDef 
# put_findings_publication_configuration method usage example with argument unpacking

kwargs: PutFindingsPublicationConfigurationRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
}

parent.put_findings_publication_configuration(**kwargs)
  1. See PutFindingsPublicationConfigurationRequestRequestTypeDef

search_resources#

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

Type annotations and code completion for boto3.client("macie2").search_resources method. boto3 documentation

# search_resources method definition

def search_resources(
    self,
    *,
    bucketCriteria: SearchResourcesBucketCriteriaTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortCriteria: SearchResourcesSortCriteriaTypeDef = ...,  # (2)
) -> SearchResourcesResponseTypeDef:  # (3)
    ...
  1. See SearchResourcesBucketCriteriaTypeDef
  2. See SearchResourcesSortCriteriaTypeDef
  3. See SearchResourcesResponseTypeDef 
# search_resources method usage example with argument unpacking

kwarg