MacieClient

Index > Macie > MacieClient

Auto-generated documentation for Macie type annotations stubs module mypy-boto3-macie.

MacieClient

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

# MacieClient usage example

from boto3.session import Session
from mypy_boto3_macie.client import MacieClient

def get_macie_client() -> MacieClient:
    return Session().client("macie")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("macie")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalException,
    client.exceptions.InvalidInputException,
    client.exceptions.LimitExceededException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_macie.client import Exceptions

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

Methods

associate_member_account

(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member account.

Type annotations and code completion for boto3.client("macie").associate_member_account method. boto3 documentation

# associate_member_account method definition

def associate_member_account(
    self,
    *,
    memberAccountId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# associate_member_account method usage example with argument unpacking

kwargs: AssociateMemberAccountRequestRequestTypeDef = {  # (1)
    "memberAccountId": ...,
}

parent.associate_member_account(**kwargs)

1. See AssociateMemberAccountRequestRequestTypeDef

associate_s3_resources

(Discontinued) Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification.

Type annotations and code completion for boto3.client("macie").associate_s3_resources method. boto3 documentation

# associate_s3_resources method definition

def associate_s3_resources(
    self,
    *,
    s3Resources: Sequence[S3ResourceClassificationTypeDef],  # (1)
    memberAccountId: str = ...,
) -> AssociateS3ResourcesResultTypeDef:  # (2)
    ...

1. See S3ResourceClassificationTypeDef
2. See AssociateS3ResourcesResultTypeDef

# associate_s3_resources method usage example with argument unpacking

kwargs: AssociateS3ResourcesRequestRequestTypeDef = {  # (1)
    "s3Resources": ...,
}

parent.associate_s3_resources(**kwargs)

1. See AssociateS3ResourcesRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# close method definition

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

disassociate_member_account

(Discontinued) Removes the specified member account from Amazon Macie Classic.

Type annotations and code completion for boto3.client("macie").disassociate_member_account method. boto3 documentation

# disassociate_member_account method definition

def disassociate_member_account(
    self,
    *,
    memberAccountId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# disassociate_member_account method usage example with argument unpacking

kwargs: DisassociateMemberAccountRequestRequestTypeDef = {  # (1)
    "memberAccountId": ...,
}

parent.disassociate_member_account(**kwargs)

1. See DisassociateMemberAccountRequestRequestTypeDef

disassociate_s3_resources

(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie Classic.

Type annotations and code completion for boto3.client("macie").disassociate_s3_resources method. boto3 documentation

# disassociate_s3_resources method definition

def disassociate_s3_resources(
    self,
    *,
    associatedS3Resources: Sequence[S3ResourceTypeDef],  # (1)
    memberAccountId: str = ...,
) -> DisassociateS3ResourcesResultTypeDef:  # (2)
    ...

1. See S3ResourceTypeDef
2. See DisassociateS3ResourcesResultTypeDef

# disassociate_s3_resources method usage example with argument unpacking

kwargs: DisassociateS3ResourcesRequestRequestTypeDef = {  # (1)
    "associatedS3Resources": ...,
}

parent.disassociate_s3_resources(**kwargs)

1. See DisassociateS3ResourcesRequestRequestTypeDef

generate_presigned_url

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

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

list_member_accounts

(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.

Type annotations and code completion for boto3.client("macie").list_member_accounts method. boto3 documentation

# list_member_accounts method definition

def list_member_accounts(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMemberAccountsResultTypeDef:  # (1)
    ...

1. See ListMemberAccountsResultTypeDef

# list_member_accounts method usage example with argument unpacking

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

parent.list_member_accounts(**kwargs)

1. See ListMemberAccountsRequestRequestTypeDef

list_s3_resources

(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic.

Type annotations and code completion for boto3.client("macie").list_s3_resources method. boto3 documentation

# list_s3_resources method definition

def list_s3_resources(
    self,
    *,
    memberAccountId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListS3ResourcesResultTypeDef:  # (1)
    ...

1. See ListS3ResourcesResultTypeDef

# list_s3_resources method usage example with argument unpacking

kwargs: ListS3ResourcesRequestRequestTypeDef = {  # (1)
    "memberAccountId": ...,
}

parent.list_s3_resources(**kwargs)

1. See ListS3ResourcesRequestRequestTypeDef

update_s3_resources

(Discontinued) Updates the classification types for the specified S3 resources.

Type annotations and code completion for boto3.client("macie").update_s3_resources method. boto3 documentation

# update_s3_resources method definition

def update_s3_resources(
    self,
    *,
    s3ResourcesUpdate: Sequence[S3ResourceClassificationUpdateTypeDef],  # (1)
    memberAccountId: str = ...,
) -> UpdateS3ResourcesResultTypeDef:  # (2)
    ...

1. See S3ResourceClassificationUpdateTypeDef
2. See UpdateS3ResourcesResultTypeDef

# update_s3_resources method usage example with argument unpacking

kwargs: UpdateS3ResourcesRequestRequestTypeDef = {  # (1)
    "s3ResourcesUpdate": ...,
}

parent.update_s3_resources(**kwargs)

1. See UpdateS3ResourcesRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_member_accounts") -> ListMemberAccountsPaginator
• client.get_paginator("list_s3_resources") -> ListS3ResourcesPaginator