Macie2Client

Index > Macie2 > Macie2Client

Auto-generated documentation for Macie2 type annotations stubs module types-aiobotocore-macie2.

Macie2Client

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_macie2.client import Macie2Client

session = Session()
async with session.client("macie2") as client:
    client: Macie2Client

Exceptions

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

Usage example

async with session.client("macie2") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.UnprocessableEntityException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("macie2").accept_invitation method. boto3 documentation

Method definition

await def accept_invitation(
    self,
    *,
    invitationId: str,
    administratorAccountId: str = ...,
    masterAccount: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("macie2").batch_get_custom_data_identifiers method. boto3 documentation

Method definition

await def batch_get_custom_data_identifiers(
    self,
    *,
    ids: Sequence[str] = ...,
) -> BatchGetCustomDataIdentifiersResponseTypeDef:  # (1)
    ...

1. See BatchGetCustomDataIdentifiersResponseTypeDef

Usage example with kwargs

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 session.client("macie2").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 session.client("macie2").close method. boto3 documentation

Method definition

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

create_classification_job

Creates and defines the settings for a classification job.

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

Method definition

await def create_classification_job(
    self,
    *,
    clientToken: str,
    jobType: JobTypeType,  # (1)
    name: str,
    s3JobDefinition: S3JobDefinitionTypeDef,  # (2)
    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

Usage example with kwargs

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 session.client("macie2").create_custom_data_identifier method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").create_findings_filter method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").create_invitations method. boto3 documentation

Method definition

await def create_invitations(
    self,
    *,
    accountIds: Sequence[str],
    disableEmailNotification: bool = ...,
    message: str = ...,
) -> CreateInvitationsResponseTypeDef:  # (1)
    ...

1. See CreateInvitationsResponseTypeDef

Usage example with kwargs

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 session.client("macie2").create_member method. boto3 documentation

Method definition

await def create_member(
    self,
    *,
    account: AccountDetailTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateMemberResponseTypeDef:  # (2)
    ...

1. See AccountDetailTypeDef
2. See CreateMemberResponseTypeDef

Usage example with kwargs

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

parent.create_member(**kwargs)

1. See CreateMemberRequestRequestTypeDef

create_sample_findings

Creates sample findings.

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

Method definition

await def create_sample_findings(
    self,
    *,
    findingTypes: Sequence[FindingTypeType] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See FindingTypeType

Usage example with kwargs

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 session.client("macie2").decline_invitations method. boto3 documentation

Method definition

await 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_custom_data_identifier

Soft deletes a custom data identifier.

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

Method definition

await def delete_custom_data_identifier(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("macie2").delete_findings_filter method. boto3 documentation

Method definition

await def delete_findings_filter(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("macie2").delete_invitations method. boto3 documentation

Method definition

await 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_member

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

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

Method definition

await def delete_member(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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.

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

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").describe_classification_job method. boto3 documentation

Method definition

await def describe_classification_job(
    self,
    *,
    jobId: str,
) -> DescribeClassificationJobResponseTypeDef:  # (1)
    ...

1. See DescribeClassificationJobResponseTypeDef

Usage example with kwargs

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 session.client("macie2").describe_organization_configuration method. boto3 documentation

Method definition

await 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 session.client("macie2").disable_macie method. boto3 documentation

Method definition

await 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 session.client("macie2").disable_organization_admin_account method. boto3 documentation

Method definition

await 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

disassociate_from_administrator_account

Disassociates a member account from its Amazon Macie administrator account.

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

Method definition

await 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 session.client("macie2").disassociate_from_master_account method. boto3 documentation

Method definition

await 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 session.client("macie2").disassociate_member method. boto3 documentation

Method definition

await def disassociate_member(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("macie2").enable_macie method. boto3 documentation

Method definition

await def enable_macie(
    self,
    *,
    clientToken: str = ...,
    findingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    status: MacieStatusType = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See FindingPublishingFrequencyType
2. See MacieStatusType

Usage example with kwargs

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 session.client("macie2").enable_organization_admin_account method. boto3 documentation

Method definition

await def enable_organization_admin_account(
    self,
    *,
    adminAccountId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("macie2").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("macie2").get_administrator_account method. boto3 documentation

Method definition

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

1. See GetAdministratorAccountResponseTypeDef

get_bucket_statistics

Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes.

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

Method definition

await def get_bucket_statistics(
    self,
    *,
    accountId: str = ...,
) -> GetBucketStatisticsResponseTypeDef:  # (1)
    ...

1. See GetBucketStatisticsResponseTypeDef

Usage example with kwargs

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 session.client("macie2").get_classification_export_configuration method. boto3 documentation

Method definition

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

1. See GetClassificationExportConfigurationResponseTypeDef

get_custom_data_identifier

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

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

Method definition

await def get_custom_data_identifier(
    self,
    *,
    id: str,
) -> GetCustomDataIdentifierResponseTypeDef:  # (1)
    ...

1. See GetCustomDataIdentifierResponseTypeDef

Usage example with kwargs

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 session.client("macie2").get_finding_statistics method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").get_findings method. boto3 documentation

Method definition

await def get_findings(
    self,
    *,
    findingIds: Sequence[str],
    sortCriteria: SortCriteriaTypeDef = ...,  # (1)
) -> GetFindingsResponseTypeDef:  # (2)
    ...

1. See SortCriteriaTypeDef
2. See GetFindingsResponseTypeDef

Usage example with kwargs

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 session.client("macie2").get_findings_filter method. boto3 documentation

Method definition

await def get_findings_filter(
    self,
    *,
    id: str,
) -> GetFindingsFilterResponseTypeDef:  # (1)
    ...

1. See GetFindingsFilterResponseTypeDef

Usage example with kwargs

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 session.client("macie2").get_findings_publication_configuration method. boto3 documentation

Method definition

await 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 session.client("macie2").get_invitations_count method. boto3 documentation

Method definition

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

1. See GetInvitationsCountResponseTypeDef

get_macie_session

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

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

Method definition

await 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 session.client("macie2").get_master_account method. boto3 documentation

Method definition

await 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 session.client("macie2").get_member method. boto3 documentation

Method definition

await def get_member(
    self,
    *,
    id: str,
) -> GetMemberResponseTypeDef:  # (1)
    ...

1. See GetMemberResponseTypeDef

Usage example with kwargs

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

parent.get_member(**kwargs)

1. See GetMemberRequestRequestTypeDef

get_reveal_configuration

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

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

Method definition

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

1. See GetRevealConfigurationResponseTypeDef

get_sensitive_data_occurrences

Retrieves (reveals) occurrences of sensitive data reported by a finding.

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

Method definition

await def get_sensitive_data_occurrences(
    self,
    *,
    findingId: str,
) -> GetSensitiveDataOccurrencesResponseTypeDef:  # (1)
    ...

1. See GetSensitiveDataOccurrencesResponseTypeDef

Usage example with kwargs

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 (revealed) for a finding.

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

Method definition

await def get_sensitive_data_occurrences_availability(
    self,
    *,
    findingId: str,
) -> GetSensitiveDataOccurrencesAvailabilityResponseTypeDef:  # (1)
    ...

1. See GetSensitiveDataOccurrencesAvailabilityResponseTypeDef

Usage example with kwargs

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

parent.get_sensitive_data_occurrences_availability(**kwargs)

1. See GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef

get_usage_statistics

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

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

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").get_usage_totals method. boto3 documentation

Method definition

await def get_usage_totals(
    self,
    *,
    timeRange: str = ...,
) -> GetUsageTotalsResponseTypeDef:  # (1)
    ...

1. See GetUsageTotalsResponseTypeDef

Usage example with kwargs

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

parent.get_usage_totals(**kwargs)

1. See GetUsageTotalsRequestRequestTypeDef

list_classification_jobs

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

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

Method definition

await 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

Usage example with kwargs

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

parent.list_classification_jobs(**kwargs)

1. See ListClassificationJobsRequestRequestTypeDef

list_custom_data_identifiers

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

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

Method definition

await def list_custom_data_identifiers(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomDataIdentifiersResponseTypeDef:  # (1)
    ...

1. See ListCustomDataIdentifiersResponseTypeDef

Usage example with kwargs

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 session.client("macie2").list_findings method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("macie2").list_findings_filters method. boto3 documentation

Method definition

await def list_findings_filters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFindingsFiltersResponseTypeDef:  # (1)
    ...

1. See ListFindingsFiltersResponseTypeDef

Usage example with kwargs

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 session.client("macie2").list_invitations method. boto3 documentation

Method definition

await 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_managed_data_identifiers

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

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

Method definition

await def list_managed_data_identifiers(
    self,
    *,
    nextToken: str = ...,
) -> ListManagedDataIdentifiersResponseTypeDef:  # (1)
    ...

1. See ListManagedDataIdentifiersResponseTypeDef

Usage example with kwargs

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 session.client("macie2").list_members method. boto3 documentation

Method definition

await def list_members(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    onlyAssociated: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...

1. See ListMembersResponseTypeDef

Usage example with kwargs

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 session.client("macie2").list_organization_admin_accounts method. boto3 documentation

Method definition

await 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_tags_for_resource

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

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

Method definition

await 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

put_classification_export_configuration

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

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

Method definition

await def put_classification_export_configuration(
    self,
    *,
    configuration: ClassificationExportConfigurationTypeDef,  # (1)
) -> PutClassificationExportConfigurationResponseTypeDef:  # (2)
    ...

1. See ClassificationExportConfigurationTypeDef
2. See PutClassificationExportConfigurationResponseTypeDef

Usage example with kwargs

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 session.client("macie2").put_findings_publication_configuration method. boto3 documentation

Method definition

await def put_findings_publication_configuration(
    self,
    *,
    clientToken: str = ...,
    securityHubConfiguration: SecurityHubConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See SecurityHubConfigurationTypeDef

Usage example with kwargs

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 session.client("macie2").search_resources method. boto3 documentation

Method definition

await 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

Usage example with kwargs

kwargs: SearchResourcesRequestRequestTypeDef = {  # (1)
    "bucketCriteria": ...,
}

parent.search_resources(**kwargs)

1. See SearchResourcesRequestRequestTypeDef

tag_resource

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

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

Method definition

await 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

test_custom_data_identifier

Tests a custom data identifier.

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

Method definition

await def test_custom_data_identifier(
    self,
    *,
    regex: str,
    sampleText: str,
    ignoreWords: Sequence[str] = ...,
    keywords: Sequence[str] = ...,
    maximumMatchDistance: int = ...,
) -> TestCustomDataIdentifierResponseTypeDef:  # (1)
    ...

1. See TestCustomDataIdentifierResponseTypeDef

Usage example with kwargs

kwargs: TestCustomDataIdentifierRequestRequestTypeDef = {  # (1)
    "regex": ...,
    "sampleText": ...,
}

parent.test_custom_data_identifier(**kwargs)

1. See TestCustomDataIdentifierRequestRequestTypeDef

untag_resource

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

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

Method definition

await 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_classification_job

Changes the status of a classification job.

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

Method definition

await def update_classification_job(
    self,
    *,
    jobId: str,
    jobStatus: JobStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See JobStatusType

Usage example with kwargs

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

parent.update_classification_job(**kwargs)

1. See UpdateClassificationJobRequestRequestTypeDef

update_findings_filter

Updates the criteria and other settings for a findings filter.

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

Method definition

await def update_findings_filter(
    self,
    *,
    id: str,
    action: FindingsFilterActionType = ...,  # (1)
    description: str = ...,
    findingCriteria: FindingCriteriaTypeDef = ...,  # (2)
    name: str = ...,
    position: int = ...,
    clientToken: str = ...,
) -> UpdateFindingsFilterResponseTypeDef:  # (3)
    ...

1. See FindingsFilterActionType
2. See FindingCriteriaTypeDef
3. See UpdateFindingsFilterResponseTypeDef

Usage example with kwargs

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

parent.update_findings_filter(**kwargs)

1. See UpdateFindingsFilterRequestRequestTypeDef

update_macie_session

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

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

Method definition

await def update_macie_session(
    self,
    *,
    findingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    status: MacieStatusType = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See FindingPublishingFrequencyType
2. See MacieStatusType

Usage example with kwargs

kwargs: UpdateMacieSessionRequestRequestTypeDef = {  # (1)
    "findingPublishingFrequency": ...,
}

parent.update_macie_session(**kwargs)

1. See UpdateMacieSessionRequestRequestTypeDef

update_member_session

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

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

Method definition

await def update_member_session(
    self,
    *,
    id: str,
    status: MacieStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See MacieStatusType

Usage example with kwargs

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

parent.update_member_session(**kwargs)

1. See UpdateMemberSessionRequestRequestTypeDef

update_organization_configuration

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

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

Method definition

await def update_organization_configuration(
    self,
    *,
    autoEnable: bool,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_organization_configuration(**kwargs)

1. See UpdateOrganizationConfigurationRequestRequestTypeDef

update_reveal_configuration

Updates the status and configuration settings for retrieving (revealing) occurrences of sensitive data reported by findings.

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

Method definition

await def update_reveal_configuration(
    self,
    *,
    configuration: RevealConfigurationTypeDef,  # (1)
) -> UpdateRevealConfigurationResponseTypeDef:  # (2)
    ...

1. See RevealConfigurationTypeDef
2. See UpdateRevealConfigurationResponseTypeDef

Usage example with kwargs

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

parent.update_reveal_configuration(**kwargs)

1. See UpdateRevealConfigurationRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> Macie2Client:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("macie2").get_paginator method with overloads.

• client.get_paginator("describe_buckets") -> DescribeBucketsPaginator
• client.get_paginator("get_usage_statistics") -> GetUsageStatisticsPaginator
• client.get_paginator("list_classification_jobs") -> ListClassificationJobsPaginator
• client.get_paginator("list_custom_data_identifiers") -> ListCustomDataIdentifiersPaginator
• client.get_paginator("list_findings") -> ListFindingsPaginator
• client.get_paginator("list_findings_filters") -> ListFindingsFiltersPaginator
• client.get_paginator("list_invitations") -> ListInvitationsPaginator
• client.get_paginator("list_members") -> ListMembersPaginator
• client.get_paginator("list_organization_admin_accounts") -> ListOrganizationAdminAccountsPaginator
• client.get_paginator("search_resources") -> SearchResourcesPaginator

get_waiter

Type annotations and code completion for session.client("macie2").get_waiter method with overloads.

• client.get_waiter("finding_revealed") -> FindingRevealedWaiter