Struct aws_sdk_macie2::Client

pub struct Client { /* private fields */ }

Client for Amazon Macie 2

Client for invoking operations on Amazon Macie 2. Each operation on Amazon Macie 2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_macie2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_macie2::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_macie2::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn accept_invitation(&self) -> AcceptInvitation

Constructs a fluent builder for the AcceptInvitation operation.

• The fluent builder is configurable:
  • administrator_account_id(impl Into<String>) / set_administrator_account_id(Option<String>):

    The Amazon Web Services account ID for the account that sent the invitation.

  • invitation_id(impl Into<String>) / set_invitation_id(Option<String>):

    The unique identifier for the invitation to accept.

  • master_account(impl Into<String>) / set_master_account(Option<String>):

    (Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

• On success, responds with AcceptInvitationOutput
• On failure, responds with SdkError<AcceptInvitationError>

pub fn batch_get_custom_data_identifiers(&self) -> BatchGetCustomDataIdentifiers

Constructs a fluent builder for the BatchGetCustomDataIdentifiers operation.

• The fluent builder is configurable:
  • ids(Vec<String>) / set_ids(Option<Vec<String>>):

    An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

• On success, responds with BatchGetCustomDataIdentifiersOutput with field(s):
  • custom_data_identifiers(Option<Vec<BatchGetCustomDataIdentifierSummary>>):

    An array of objects, one for each custom data identifier that meets the criteria specified in the request.

  • not_found_identifier_ids(Option<Vec<String>>):

    An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn’t correlate to an existing custom data identifier.

• On failure, responds with SdkError<BatchGetCustomDataIdentifiersError>

pub fn create_classification_job(&self) -> CreateClassificationJob

Constructs a fluent builder for the CreateClassificationJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • custom_data_identifier_ids(Vec<String>) / set_custom_data_identifier_ids(Option<Vec<String>>):

    An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don’t specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

  • description(impl Into<String>) / set_description(Option<String>):

    A custom description of the job. The description can contain as many as 200 characters.

  • initial_run(bool) / set_initial_run(bool):

    For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job’s first scheduled run, set this value to false.

    If you configure the job to run only once, don’t specify a value for this property.

  • job_type(JobType) / set_job_type(Option<JobType>):

    The schedule for running the job. Valid values are:

    • ONE_TIME - Run the job only once. If you specify this value, don’t specify a value for the scheduleFrequency property.

    • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

  • managed_data_identifier_ids(Vec<String>) / set_managed_data_identifier_ids(Option<Vec<String>>):

    An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

    To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

  • managed_data_identifier_selector(ManagedDataIdentifierSelector) / set_managed_data_identifier_selector(Option<ManagedDataIdentifierSelector>):

    The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

    • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don’t specify any values for the managedDataIdentifierIds property.

    • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

    • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

    • NONE - Don’t use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don’t specify any values for the managedDataIdentifierIds property.

    If you don’t specify a value for this property, the job uses all managed data identifiers. If you don’t specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

  • name(impl Into<String>) / set_name(Option<String>):

    A custom name for the job. The name can contain as many as 500 characters.

  • s3_job_definition(S3JobDefinition) / set_s3_job_definition(Option<S3JobDefinition>):

    The S3 buckets that contain the objects to analyze, and the scope of that analysis.

  • sampling_percentage(i32) / set_sampling_percentage(i32):

    The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

  • schedule_frequency(JobScheduleFrequency) / set_schedule_frequency(Option<JobScheduleFrequency>):

    The recurrence pattern for running the job. To run the job only once, don’t specify a value for this property and set the value for the jobType property to ONE_TIME.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies the tags to associate with the job.

    A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

• On success, responds with CreateClassificationJobOutput with field(s):
  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the job.

  • job_id(Option<String>):

    The unique identifier for the job.

• On failure, responds with SdkError<CreateClassificationJobError>

pub fn create_custom_data_identifier(&self) -> CreateCustomDataIdentifier

Constructs a fluent builder for the CreateCustomDataIdentifier operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • description(impl Into<String>) / set_description(Option<String>):

    A custom description of the custom data identifier. The description can contain as many as 512 characters.

    We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they’re allowed to perform in Amazon Macie.

  • ignore_words(Vec<String>) / set_ignore_words(Option<Vec<String>>):

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

  • keywords(Vec<String>) / set_keywords(Option<Vec<String>>):

    An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren’t case sensitive.

  • maximum_match_distance(i32) / set_maximum_match_distance(i32):

    The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.

  • name(impl Into<String>) / set_name(Option<String>):

    A custom name for the custom data identifier. The name can contain as many as 128 characters.

    We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they’re allowed to perform in Amazon Macie.

  • regex(impl Into<String>) / set_regex(Option<String>):

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

  • severity_levels(Vec<SeverityLevel>) / set_severity_levels(Option<Vec<SeverityLevel>>):

    The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier’s detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn’t create a finding.

    If you don’t specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies the tags to associate with the custom data identifier.

    A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

• On success, responds with CreateCustomDataIdentifierOutput with field(s):
  • custom_data_identifier_id(Option<String>):

    The unique identifier for the custom data identifier that was created.

• On failure, responds with SdkError<CreateCustomDataIdentifierError>

pub fn create_findings_filter(&self) -> CreateFindingsFilter

Constructs a fluent builder for the CreateFindingsFilter operation.

• The fluent builder is configurable:
  • action(FindingsFilterAction) / set_action(Option<FindingsFilterAction>):

    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don’t perform any action on the findings.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • description(impl Into<String>) / set_description(Option<String>):

    A custom description of the filter. The description can contain as many as 512 characters.

    We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they’re allowed to perform in Amazon Macie.

  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):

    The criteria to use to filter findings.

  • name(impl Into<String>) / set_name(Option<String>):

    A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

    We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they’re allowed to perform in Amazon Macie.

  • position(i32) / set_position(i32):

    The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies the tags to associate with the filter.

    A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

• On success, responds with CreateFindingsFilterOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the filter that was created.

  • id(Option<String>):

    The unique identifier for the filter that was created.

• On failure, responds with SdkError<CreateFindingsFilterError>

pub fn create_invitations(&self) -> CreateInvitations

Constructs a fluent builder for the CreateInvitations operation.

• The fluent builder is configurable:
  • account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):

    An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

  • disable_email_notification(bool) / set_disable_email_notification(bool):

    Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient’s account when you associated the account with your account. The default value is false.

  • message(impl Into<String>) / set_message(Option<String>):

    Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

• On success, responds with CreateInvitationsOutput with field(s):
  • unprocessed_accounts(Option<Vec<UnprocessedAccount>>):

    An array of objects, one for each account whose invitation hasn’t been processed. Each object identifies the account and explains why the invitation hasn’t been processed for the account.

• On failure, responds with SdkError<CreateInvitationsError>

pub fn create_member(&self) -> CreateMember

Constructs a fluent builder for the CreateMember operation.

• The fluent builder is configurable:
  • account(AccountDetail) / set_account(Option<AccountDetail>):

    The details of the account to associate with the administrator account.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

    An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

• On success, responds with CreateMemberOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the account that was associated with the administrator account.

• On failure, responds with SdkError<CreateMemberError>

pub fn create_sample_findings(&self) -> CreateSampleFindings

Constructs a fluent builder for the CreateSampleFindings operation.

• The fluent builder is configurable:
  • finding_types(Vec<FindingType>) / set_finding_types(Option<Vec<FindingType>>):

    An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don’t include this array in your request.

• On success, responds with CreateSampleFindingsOutput
• On failure, responds with SdkError<CreateSampleFindingsError>

pub fn decline_invitations(&self) -> DeclineInvitations

Constructs a fluent builder for the DeclineInvitations operation.

• The fluent builder is configurable:
  • account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):

    An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.

• On success, responds with DeclineInvitationsOutput with field(s):
  • unprocessed_accounts(Option<Vec<UnprocessedAccount>>):

    An array of objects, one for each account whose invitation hasn’t been declined. Each object identifies the account and explains why the request hasn’t been processed for that account.

• On failure, responds with SdkError<DeclineInvitationsError>

pub fn delete_custom_data_identifier(&self) -> DeleteCustomDataIdentifier

Constructs a fluent builder for the DeleteCustomDataIdentifier operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with DeleteCustomDataIdentifierOutput
• On failure, responds with SdkError<DeleteCustomDataIdentifierError>

pub fn delete_findings_filter(&self) -> DeleteFindingsFilter

Constructs a fluent builder for the DeleteFindingsFilter operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with DeleteFindingsFilterOutput
• On failure, responds with SdkError<DeleteFindingsFilterError>

pub fn delete_invitations(&self) -> DeleteInvitations

Constructs a fluent builder for the DeleteInvitations operation.

• The fluent builder is configurable:
  • account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):

    An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.

• On success, responds with DeleteInvitationsOutput with field(s):
  • unprocessed_accounts(Option<Vec<UnprocessedAccount>>):

    An array of objects, one for each account whose invitation hasn’t been deleted. Each object identifies the account and explains why the request hasn’t been processed for that account.

• On failure, responds with SdkError<DeleteInvitationsError>

pub fn delete_member(&self) -> DeleteMember

Constructs a fluent builder for the DeleteMember operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with DeleteMemberOutput
• On failure, responds with SdkError<DeleteMemberError>

pub fn describe_buckets(&self) -> DescribeBuckets

Constructs a fluent builder for the DescribeBuckets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • criteria(HashMap<String, BucketCriteriaAdditionalProperties>) / set_criteria(Option<HashMap<String, BucketCriteriaAdditionalProperties>>):

    The criteria to use to filter the query results.

  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response. The default value is 50.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • sort_criteria(BucketSortCriteria) / set_sort_criteria(Option<BucketSortCriteria>):

    The criteria to use to sort the query results.

• On success, responds with DescribeBucketsOutput with field(s):
  • buckets(Option<Vec<BucketMetadata>>):

    An array of objects, one for each bucket that meets the filter criteria specified in the request.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<DescribeBucketsError>

pub fn describe_classification_job(&self) -> DescribeClassificationJob

Constructs a fluent builder for the DescribeClassificationJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):

    The unique identifier for the classification job.

• On success, responds with DescribeClassificationJobOutput with field(s):
  • client_token(Option<String>):

    The token that was provided to ensure the idempotency of the request to create the job.

  • created_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when the job was created.

  • custom_data_identifier_ids(Option<Vec<String>>):

    An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.

  • description(Option<String>):

    The custom description of the job.

  • initial_run(bool):

    For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job’s first scheduled run, this value is false. This value is also false for a one-time job.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the job.

  • job_id(Option<String>):

    The unique identifier for the job.

  • job_status(Option<JobStatus>):

    The current status of the job. Possible values are:

    • CANCELLED - You cancelled the job or, if it’s a one-time job, you paused the job and didn’t resume it within 30 days.

    • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn’t apply to recurring jobs.

    • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn’t apply to one-time jobs.

    • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

    • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

    • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don’t resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job’s type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

  • job_type(Option<JobType>):

    The schedule for running the job. Possible values are:

    • ONE_TIME - The job runs only once.

    • SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.

  • last_run_error_status(Option<LastRunErrorStatus>):

    Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job’s most recent run.

  • last_run_time(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

  • managed_data_identifier_ids(Option<Vec<String>>):

    An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector). This value is null if the job’s managed data identifier selection type is ALL or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.

  • managed_data_identifier_selector(Option<ManagedDataIdentifierSelector>):

    The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:

    • ALL - Use all the managed data identifiers that Amazon Macie provides.

    • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

    • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

    • NONE - Don’t use any managed data identifiers.

    If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

  • name(Option<String>):

    The custom name of the job.

  • s3_job_definition(Option<S3JobDefinition>):

    The S3 buckets that contain the objects to analyze, and the scope of that analysis.

  • sampling_percentage(i32):

    The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

  • schedule_frequency(Option<JobScheduleFrequency>):

    The recurrence pattern for running the job. This value is null if the job is configured to run only once.

  • statistics(Option<Statistics>):

    The number of times that the job has run and processing statistics for the job’s current run.

  • tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

  • user_paused_details(Option<UserPausedDetails>):

    If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn’t resumed. This value is present only if the value for jobStatus is USER_PAUSED.

• On failure, responds with SdkError<DescribeClassificationJobError>

pub fn describe_organization_configuration(
    &self
) -> DescribeOrganizationConfiguration

Constructs a fluent builder for the DescribeOrganizationConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeOrganizationConfigurationOutput with field(s):
  • auto_enable(bool):

    Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.

  • max_account_limit_reached(bool):

    Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.

• On failure, responds with SdkError<DescribeOrganizationConfigurationError>

pub fn disable_macie(&self) -> DisableMacie

Constructs a fluent builder for the DisableMacie operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisableMacieOutput
• On failure, responds with SdkError<DisableMacieError>

pub fn disable_organization_admin_account(
    &self
) -> DisableOrganizationAdminAccount

Constructs a fluent builder for the DisableOrganizationAdminAccount operation.

• The fluent builder is configurable:
  • admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):

    The Amazon Web Services account ID of the delegated Amazon Macie administrator account.

• On success, responds with DisableOrganizationAdminAccountOutput
• On failure, responds with SdkError<DisableOrganizationAdminAccountError>

pub fn disassociate_from_administrator_account(
    &self
) -> DisassociateFromAdministratorAccount

Constructs a fluent builder for the DisassociateFromAdministratorAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisassociateFromAdministratorAccountOutput
• On failure, responds with SdkError<DisassociateFromAdministratorAccountError>

pub fn disassociate_from_master_account(&self) -> DisassociateFromMasterAccount

Constructs a fluent builder for the DisassociateFromMasterAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisassociateFromMasterAccountOutput
• On failure, responds with SdkError<DisassociateFromMasterAccountError>

pub fn disassociate_member(&self) -> DisassociateMember

Constructs a fluent builder for the DisassociateMember operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with DisassociateMemberOutput
• On failure, responds with SdkError<DisassociateMemberError>

pub fn enable_macie(&self) -> EnableMacie

Constructs a fluent builder for the EnableMacie operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • finding_publishing_frequency(FindingPublishingFrequency) / set_finding_publishing_frequency(Option<FindingPublishingFrequency>):

    Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

  • status(MacieStatus) / set_status(Option<MacieStatus>):

    Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

• On success, responds with EnableMacieOutput
• On failure, responds with SdkError<EnableMacieError>

pub fn enable_organization_admin_account(
    &self
) -> EnableOrganizationAdminAccount

Constructs a fluent builder for the EnableOrganizationAdminAccount operation.

• The fluent builder is configurable:
  • admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):

    The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

• On success, responds with EnableOrganizationAdminAccountOutput
• On failure, responds with SdkError<EnableOrganizationAdminAccountError>

pub fn get_administrator_account(&self) -> GetAdministratorAccount

Constructs a fluent builder for the GetAdministratorAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAdministratorAccountOutput with field(s):
  • administrator(Option<Invitation>):

    The Amazon Web Services account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

• On failure, responds with SdkError<GetAdministratorAccountError>

pub fn get_bucket_statistics(&self) -> GetBucketStatistics

Constructs a fluent builder for the GetBucketStatistics operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):

    The unique identifier for the Amazon Web Services account.

• On success, responds with GetBucketStatisticsOutput with field(s):
  • bucket_count(i64):

    The total number of buckets.

  • bucket_count_by_effective_permission(Option<BucketCountByEffectivePermission>):

    The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.

  • bucket_count_by_encryption_type(Option<BucketCountByEncryptionType>):

    The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don’t encrypt new objects by default.

  • bucket_count_by_object_encryption_requirement(Option<BucketCountPolicyAllowsUnencryptedObjectUploads>):

    The total number of buckets whose bucket policies do or don’t require server-side encryption of objects when objects are uploaded to the buckets.

  • bucket_count_by_shared_access_type(Option<BucketCountBySharedAccessType>):

    The total number of buckets that are or aren’t shared with another Amazon Web Services account.

  • classifiable_object_count(i64):

    The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

  • classifiable_size_in_bytes(i64):

    The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

    If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn’t reflect the storage size of all versions of all applicable objects in the buckets.

  • last_updated(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.

  • object_count(i64):

    The total number of objects in the buckets.

  • size_in_bytes(i64):

    The total storage size, in bytes, of the buckets.

    If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn’t reflect the storage size of all versions of the objects in the buckets.

  • size_in_bytes_compressed(i64):

    The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.

    If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn’t reflect the storage size of all versions of the applicable objects in the buckets.

  • unclassifiable_object_count(Option<ObjectLevelStatistics>):

    The total number of objects that Amazon Macie can’t analyze in the buckets. These objects don’t use a supported storage class or don’t have a file name extension for a supported file or storage format.

  • unclassifiable_object_size_in_bytes(Option<ObjectLevelStatistics>):

    The total storage size, in bytes, of the objects that Amazon Macie can’t analyze in the buckets. These objects don’t use a supported storage class or don’t have a file name extension for a supported file or storage format.

• On failure, responds with SdkError<GetBucketStatisticsError>

pub fn get_classification_export_configuration(
    &self
) -> GetClassificationExportConfiguration

Constructs a fluent builder for the GetClassificationExportConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetClassificationExportConfigurationOutput with field(s):
  • configuration(Option<ClassificationExportConfiguration>):

    The location where data classification results are stored, and the encryption settings that are used when storing results in that location.

• On failure, responds with SdkError<GetClassificationExportConfigurationError>

pub fn get_custom_data_identifier(&self) -> GetCustomDataIdentifier

Constructs a fluent builder for the GetCustomDataIdentifier operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with GetCustomDataIdentifierOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom data identifier.

  • created_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

  • deleted(bool):

    Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn’t delete it permanently. Instead, it soft deletes the identifier.

  • description(Option<String>):

    The custom description of the custom data identifier.

  • id(Option<String>):

    The unique identifier for the custom data identifier.

  • ignore_words(Option<Vec<String>>):

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

  • keywords(Option<Vec<String>>):

    An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren’t case sensitive.

  • maximum_match_distance(i32):

    The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression.

  • name(Option<String>):

    The custom name of the custom data identifier.

  • regex(Option<String>):

    The regular expression (regex) that defines the pattern to match.

  • severity_levels(Option<Vec<SeverityLevel>>):

    Specifies the severity that’s assigned to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier’s detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

  • tags(Option<HashMap<String, String>>):

    A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

• On failure, responds with SdkError<GetCustomDataIdentifierError>

pub fn get_findings(&self) -> GetFindings

Constructs a fluent builder for the GetFindings operation.

• The fluent builder is configurable:
  • finding_ids(Vec<String>) / set_finding_ids(Option<Vec<String>>):

    An array of strings that lists the unique identifiers for the findings to retrieve.

  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):

    The criteria for sorting the results of the request.

• On success, responds with GetFindingsOutput with field(s):
  • findings(Option<Vec<Finding>>):

    An array of objects, one for each finding that meets the criteria specified in the request.

• On failure, responds with SdkError<GetFindingsError>

pub fn get_findings_filter(&self) -> GetFindingsFilter

Constructs a fluent builder for the GetFindingsFilter operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with GetFindingsFilterOutput with field(s):
  • action(Option<FindingsFilterAction>):

    The action that’s performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don’t perform any action on the findings.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the filter.

  • description(Option<String>):

    The custom description of the filter.

  • finding_criteria(Option<FindingCriteria>):

    The criteria that’s used to filter findings.

  • id(Option<String>):

    The unique identifier for the filter.

  • name(Option<String>):

    The custom name of the filter.

  • position(i32):

    The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

  • tags(Option<HashMap<String, String>>):

    A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

• On failure, responds with SdkError<GetFindingsFilterError>

pub fn get_findings_publication_configuration(
    &self
) -> GetFindingsPublicationConfiguration

Constructs a fluent builder for the GetFindingsPublicationConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetFindingsPublicationConfigurationOutput with field(s):
  • security_hub_configuration(Option<SecurityHubConfiguration>):

    The configuration settings that determine which findings are published to Security Hub.

• On failure, responds with SdkError<GetFindingsPublicationConfigurationError>

pub fn get_finding_statistics(&self) -> GetFindingStatistics

Constructs a fluent builder for the GetFindingStatistics operation.

• The fluent builder is configurable:
  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):

    The criteria to use to filter the query results.

  • group_by(GroupBy) / set_group_by(Option<GroupBy>):

    The finding property to use to group the query results. Valid values are:

    • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

    • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

    • severity.description - The severity level of the finding, such as High or Medium.

    • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

  • size(i32) / set_size(i32):

    The maximum number of items to include in each page of the response.

  • sort_criteria(FindingStatisticsSortCriteria) / set_sort_criteria(Option<FindingStatisticsSortCriteria>):

    The criteria to use to sort the query results.

• On success, responds with GetFindingStatisticsOutput with field(s):
  • counts_by_group(Option<Vec<GroupCount>>):

    An array of objects, one for each group of findings that meet the filter criteria specified in the request.

• On failure, responds with SdkError<GetFindingStatisticsError>

pub fn get_invitations_count(&self) -> GetInvitationsCount

Constructs a fluent builder for the GetInvitationsCount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetInvitationsCountOutput with field(s):
  • invitations_count(i64):

    The total number of invitations that were received by the account, not including the currently accepted invitation.

• On failure, responds with SdkError<GetInvitationsCountError>

pub fn get_macie_session(&self) -> GetMacieSession

Constructs a fluent builder for the GetMacieSession operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetMacieSessionOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

  • finding_publishing_frequency(Option<FindingPublishingFrequency>):

    The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

  • service_role(Option<String>):

    The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.

  • status(Option<MacieStatus>):

    The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.

  • updated_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.

• On failure, responds with SdkError<GetMacieSessionError>

pub fn get_master_account(&self) -> GetMasterAccount

Constructs a fluent builder for the GetMasterAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetMasterAccountOutput with field(s):
  • master(Option<Invitation>):

    (Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

• On failure, responds with SdkError<GetMasterAccountError>

pub fn get_member(&self) -> GetMember

Constructs a fluent builder for the GetMember operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

• On success, responds with GetMemberOutput with field(s):
  • account_id(Option<String>):

    The Amazon Web Services account ID for the account.

  • administrator_account_id(Option<String>):

    The Amazon Web Services account ID for the administrator account.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the account.

  • email(Option<String>):

    The email address for the account.

  • invited_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if an invitation hasn’t been sent to the account.

  • master_account_id(Option<String>):

    (Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

  • relationship_status(Option<RelationshipStatus>):

    The current status of the relationship between the account and the administrator account.

  • tags(Option<HashMap<String, String>>):

    A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

  • updated_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

• On failure, responds with SdkError<GetMemberError>

pub fn get_usage_statistics(&self) -> GetUsageStatistics

Constructs a fluent builder for the GetUsageStatistics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_by(Vec<UsageStatisticsFilter>) / set_filter_by(Option<Vec<UsageStatisticsFilter>>):

    An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • sort_by(UsageStatisticsSortBy) / set_sort_by(Option<UsageStatisticsSortBy>):

    The criteria to use to sort the query results.

  • time_range(TimeRange) / set_time_range(Option<TimeRange>):

    The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don’t specify a value, Amazon Macie provides usage data for the preceding 30 days.

• On success, responds with GetUsageStatisticsOutput with field(s):
  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • records(Option<Vec<UsageRecord>>):

    An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.

  • time_range(Option<TimeRange>):

    The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

• On failure, responds with SdkError<GetUsageStatisticsError>

pub fn get_usage_totals(&self) -> GetUsageTotals

Constructs a fluent builder for the GetUsageTotals operation.

• The fluent builder is configurable:
  • time_range(impl Into<String>) / set_time_range(Option<String>):

    The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don’t specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

• On success, responds with GetUsageTotalsOutput with field(s):
  • time_range(Option<TimeRange>):

    The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

  • usage_totals(Option<Vec<UsageTotal>>):

    An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

• On failure, responds with SdkError<GetUsageTotalsError>

pub fn list_classification_jobs(&self) -> ListClassificationJobs

Constructs a fluent builder for the ListClassificationJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_criteria(ListJobsFilterCriteria) / set_filter_criteria(Option<ListJobsFilterCriteria>):

    The criteria to use to filter the results.

  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • sort_criteria(ListJobsSortCriteria) / set_sort_criteria(Option<ListJobsSortCriteria>):

    The criteria to use to sort the results.

• On success, responds with ListClassificationJobsOutput with field(s):
  • items(Option<Vec<JobSummary>>):

    An array of objects, one for each job that meets the filter criteria specified in the request.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListClassificationJobsError>

pub fn list_custom_data_identifiers(&self) -> ListCustomDataIdentifiers

Constructs a fluent builder for the ListCustomDataIdentifiers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

• On success, responds with ListCustomDataIdentifiersOutput with field(s):
  • items(Option<Vec<CustomDataIdentifierSummary>>):

    An array of objects, one for each custom data identifier.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListCustomDataIdentifiersError>

pub fn list_findings(&self) -> ListFindings

Constructs a fluent builder for the ListFindings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):

    The criteria to use to filter the results.

  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):

    The criteria to use to sort the results.

• On success, responds with ListFindingsOutput with field(s):
  • finding_ids(Option<Vec<String>>):

    An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListFindingsError>

pub fn list_findings_filters(&self) -> ListFindingsFilters

Constructs a fluent builder for the ListFindingsFilters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of a paginated response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

• On success, responds with ListFindingsFiltersOutput with field(s):
  • findings_filter_list_items(Option<Vec<FindingsFilterListItem>>):

    An array of objects, one for each filter that’s associated with the account.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListFindingsFiltersError>

pub fn list_invitations(&self) -> ListInvitations

Constructs a fluent builder for the ListInvitations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of a paginated response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

• On success, responds with ListInvitationsOutput with field(s):
  • invitations(Option<Vec<Invitation>>):

    An array of objects, one for each invitation that was received by the account.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListInvitationsError>

pub fn list_managed_data_identifiers(&self) -> ListManagedDataIdentifiers

Constructs a fluent builder for the ListManagedDataIdentifiers operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

• On success, responds with ListManagedDataIdentifiersOutput with field(s):
  • items(Option<Vec<ManagedDataIdentifierSummary>>):

    An array of objects, one for each managed data identifier.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListManagedDataIdentifiersError>

pub fn list_members(&self) -> ListMembers

Constructs a fluent builder for the ListMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of a paginated response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • only_associated(impl Into<String>) / set_only_associated(Option<String>):

    Specifies which accounts to include in the response, based on the status of an account’s relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.

• On success, responds with ListMembersOutput with field(s):
  • members(Option<Vec<Member>>):

    An array of objects, one for each account that’s associated with the administrator account and meets the criteria specified in the request.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListMembersError>

pub fn list_organization_admin_accounts(&self) -> ListOrganizationAdminAccounts

Constructs a fluent builder for the ListOrganizationAdminAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of a paginated response.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

• On success, responds with ListOrganizationAdminAccountsOutput with field(s):
  • admin_accounts(Option<Vec<AdminAccount>>):

    An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<ListOrganizationAdminAccountsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    A map of key-value pairs that identifies the tags (keys and values) that are associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn put_classification_export_configuration(
    &self
) -> PutClassificationExportConfiguration

Constructs a fluent builder for the PutClassificationExportConfiguration operation.

• The fluent builder is configurable:
  • configuration(ClassificationExportConfiguration) / set_configuration(Option<ClassificationExportConfiguration>):

    The location to store data classification results in, and the encryption settings to use when storing results in that location.

• On success, responds with PutClassificationExportConfigurationOutput with field(s):
  • configuration(Option<ClassificationExportConfiguration>):

    The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.

• On failure, responds with SdkError<PutClassificationExportConfigurationError>

pub fn put_findings_publication_configuration(
    &self
) -> PutFindingsPublicationConfiguration

Constructs a fluent builder for the PutFindingsPublicationConfiguration operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • security_hub_configuration(SecurityHubConfiguration) / set_security_hub_configuration(Option<SecurityHubConfiguration>):

    The configuration settings that determine which findings to publish to Security Hub.

• On success, responds with PutFindingsPublicationConfigurationOutput
• On failure, responds with SdkError<PutFindingsPublicationConfigurationError>

pub fn search_resources(&self) -> SearchResources

Constructs a fluent builder for the SearchResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bucket_criteria(SearchResourcesBucketCriteria) / set_bucket_criteria(Option<SearchResourcesBucketCriteria>):

    The filter conditions that determine which S3 buckets to include or exclude from the query results.

  • max_results(i32) / set_max_results(i32):

    The maximum number of items to include in each page of the response. The default value is 50.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken string that specifies which page of results to return in a paginated response.

  • sort_criteria(SearchResourcesSortCriteria) / set_sort_criteria(Option<SearchResourcesSortCriteria>):

    The criteria to use to sort the results.

• On success, responds with SearchResourcesOutput with field(s):
  • matching_resources(Option<Vec<MatchingResource>>):

    An array of objects, one for each resource that meets the filter criteria specified in the request.

  • next_token(Option<String>):

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

• On failure, responds with SdkError<SearchResourcesError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map of key-value pairs that specifies the tags to associate with the resource.

    A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn test_custom_data_identifier(&self) -> TestCustomDataIdentifier

Constructs a fluent builder for the TestCustomDataIdentifier operation.

• The fluent builder is configurable:
  • ignore_words(Vec<String>) / set_ignore_words(Option<Vec<String>>):

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

  • keywords(Vec<String>) / set_keywords(Option<Vec<String>>):

    An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren’t case sensitive.

  • maximum_match_distance(i32) / set_maximum_match_distance(i32):

    The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.

  • regex(impl Into<String>) / set_regex(Option<String>):

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

  • sample_text(impl Into<String>) / set_sample_text(Option<String>):

    The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

• On success, responds with TestCustomDataIdentifierOutput with field(s):
  • match_count(i32):

    The number of occurrences of sample text that matched the criteria specified by the custom data identifier.

• On failure, responds with SdkError<TestCustomDataIdentifierError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_classification_job(&self) -> UpdateClassificationJob

Constructs a fluent builder for the UpdateClassificationJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):

    The unique identifier for the classification job.

  • job_status(JobStatus) / set_job_status(Option<JobStatus>):

    The new status for the job. Valid values are:

    • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job’s current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

      If you specify this value and the job’s current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can’t resume or restart a job after you cancel it.

    • RUNNING - Resumes the job. This value is valid only if the job’s current status is USER_PAUSED.

      If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

    • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job’s current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job’s current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

      If you pause a one-time job and you don’t resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don’t resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

• On success, responds with UpdateClassificationJobOutput
• On failure, responds with SdkError<UpdateClassificationJobError>

pub fn update_findings_filter(&self) -> UpdateFindingsFilter

Constructs a fluent builder for the UpdateFindingsFilter operation.

• The fluent builder is configurable:
  • action(FindingsFilterAction) / set_action(Option<FindingsFilterAction>):

    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don’t perform any action on the findings.

  • description(impl Into<String>) / set_description(Option<String>):

    A custom description of the filter. The description can contain as many as 512 characters.

    We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see this description, depending on the actions that they’re allowed to perform in Amazon Macie.

  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):

    The criteria to use to filter findings.

  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

  • name(impl Into<String>) / set_name(Option<String>):

    A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

    We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see this name, depending on the actions that they’re allowed to perform in Amazon Macie.

  • position(i32) / set_position(i32):

    The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

• On success, responds with UpdateFindingsFilterOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the filter that was updated.

  • id(Option<String>):

    The unique identifier for the filter that was updated.

• On failure, responds with SdkError<UpdateFindingsFilterError>

pub fn update_macie_session(&self) -> UpdateMacieSession

Constructs a fluent builder for the UpdateMacieSession operation.

• The fluent builder is configurable:
  • finding_publishing_frequency(FindingPublishingFrequency) / set_finding_publishing_frequency(Option<FindingPublishingFrequency>):

    Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

  • status(MacieStatus) / set_status(Option<MacieStatus>):

    Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

• On success, responds with UpdateMacieSessionOutput
• On failure, responds with SdkError<UpdateMacieSessionError>

pub fn update_member_session(&self) -> UpdateMemberSession

Constructs a fluent builder for the UpdateMemberSession operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The unique identifier for the Amazon Macie resource or account that the request applies to.

  • status(MacieStatus) / set_status(Option<MacieStatus>):

    Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

• On success, responds with UpdateMemberSessionOutput
• On failure, responds with SdkError<UpdateMemberSessionError>

pub fn update_organization_configuration(
    &self
) -> UpdateOrganizationConfiguration

Constructs a fluent builder for the UpdateOrganizationConfiguration operation.

• The fluent builder is configurable:
  • auto_enable(bool) / set_auto_enable(bool):

    Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.

• On success, responds with UpdateOrganizationConfigurationOutput
• On failure, responds with SdkError<UpdateOrganizationConfigurationError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Performs the conversion.