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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_macie2::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_macie2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptInvitation operation has a Client::accept_invitation, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_invitation()
    .administrator_account_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn accept_invitation(&self) -> AcceptInvitationFluentBuilder

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>):
    required: false
    

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

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

    The unique identifier for the invitation to accept.

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

    (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>

impl Client

pub fn batch_get_custom_data_identifiers( &self ) -> BatchGetCustomDataIdentifiersFluentBuilder

Constructs a fluent builder for the BatchGetCustomDataIdentifiers operation.

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

    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 matches 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>

impl Client

pub fn create_allow_list(&self) -> CreateAllowListFluentBuilder

Constructs a fluent builder for the CreateAllowList operation.

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

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

    
    
  • criteria(AllowListCriteria) / set_criteria(Option<AllowListCriteria>):
    required: true
    

    The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

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

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

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

    A custom name for the allow list. The name can contain as many as 128 characters.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    An allow list 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 CreateAllowListOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the allow list.

  • id(Option<String>):

    The unique identifier for the allow list.

• On failure, responds with SdkError<CreateAllowListError>

impl Client

pub fn create_classification_job(&self) -> CreateClassificationJobFluentBuilder

Constructs a fluent builder for the CreateClassificationJob operation.

• The fluent builder is configurable:
  • allow_list_ids(impl Into<String>) / set_allow_list_ids(Option<Vec::<String>>):
    required: false
    

    An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

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

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

    
    
  • custom_data_identifier_ids(impl Into<String>) / set_custom_data_identifier_ids(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • initial_run(bool) / set_initial_run(Option<bool>):
    required: false
    

    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>):
    required: true
    

    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(impl Into<String>) / set_managed_data_identifier_ids(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

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

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

    • EXCLUDE - Use all managed data identifiers except the ones 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 value for the customDataIdentifierIds property and don’t specify any values for the managedDataIdentifierIds property.

    • RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don’t specify any values for the managedDataIdentifierIds property.

    If you don’t specify a value for this property, the job uses the recommended set of managed data identifiers.

    If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don’t specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

    For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

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

    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>):
    required: true
    

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

    
    
  • sampling_percentage(i32) / set_sampling_percentage(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

impl Client

pub fn create_custom_data_identifier( &self ) -> CreateCustomDataIdentifierFluentBuilder

Constructs a fluent builder for the CreateCustomDataIdentifier operation.

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

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

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

    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(impl Into<String>) / set_ignore_words(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_keywords(Option<Vec::<String>>):
    required: false
    

    An array that lists specific character sequences (keywords), one of which must precede and 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(Option<i32>):
    required: false
    

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

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

    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>):
    required: true
    

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

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

    The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

impl Client

pub fn create_findings_filter(&self) -> CreateFindingsFilterFluentBuilder

Constructs a fluent builder for the CreateFindingsFilter operation.

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

    The action to perform on findings that match 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>):
    required: false
    

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

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

    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>):
    required: true
    

    The criteria to use to filter findings.

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

    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(Option<i32>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

impl Client

pub fn create_invitations(&self) -> CreateInvitationsFluentBuilder

Constructs a fluent builder for the CreateInvitations operation.

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

    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(Option<bool>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn create_member(&self) -> CreateMemberFluentBuilder

Constructs a fluent builder for the CreateMember operation.

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

impl Client

pub fn create_sample_findings(&self) -> CreateSampleFindingsFluentBuilder

Constructs a fluent builder for the CreateSampleFindings operation.

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

    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>

impl Client

pub fn decline_invitations(&self) -> DeclineInvitationsFluentBuilder

Constructs a fluent builder for the DeclineInvitations operation.

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

    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>

impl Client

pub fn delete_allow_list(&self) -> DeleteAllowListFluentBuilder

Constructs a fluent builder for the DeleteAllowList operation.

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

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

    
    
  • ignore_job_checks(impl Into<String>) / set_ignore_job_checks(Option<String>):
    required: false
    

    Specifies whether to force deletion of the allow list, even if active classification jobs are configured to use the list.

    When you try to delete an allow list, Amazon Macie checks for classification jobs that use the list and have a status other than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet these criteria. To skip these checks and delete the list, set this value to true. To delete the list only if no active jobs are configured to use it, set this value to false.

    
    
• On success, responds with DeleteAllowListOutput
• On failure, responds with SdkError<DeleteAllowListError>

impl Client

pub fn delete_custom_data_identifier( &self ) -> DeleteCustomDataIdentifierFluentBuilder

Constructs a fluent builder for the DeleteCustomDataIdentifier operation.

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

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

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

impl Client

pub fn delete_findings_filter(&self) -> DeleteFindingsFilterFluentBuilder

Constructs a fluent builder for the DeleteFindingsFilter operation.

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

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

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

impl Client

pub fn delete_invitations(&self) -> DeleteInvitationsFluentBuilder

Constructs a fluent builder for the DeleteInvitations operation.

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

    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>

impl Client

pub fn delete_member(&self) -> DeleteMemberFluentBuilder

Constructs a fluent builder for the DeleteMember operation.

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

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

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

impl Client

pub fn describe_buckets(&self) -> DescribeBucketsFluentBuilder

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

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

    The criteria to use to filter the query results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

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

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

    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 matches 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>

impl Client

pub fn describe_classification_job( &self ) -> DescribeClassificationJobFluentBuilder

Constructs a fluent builder for the DescribeClassificationJob operation.

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

    The unique identifier for the classification job.

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

    An array of unique identifiers, one for each allow list that the job uses when it analyzes data.

  • 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 when it analyzes 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(Option<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 or, if the job hasn’t run yet, when the job was created.

  • 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, NONE, or RECOMMENDED.

  • managed_data_identifier_selector(Option<ManagedDataIdentifierSelector>):

    The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

    • ALL - Use all managed data identifiers.

    • EXCLUDE - Use all managed data identifiers except the ones 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. Use only custom data identifiers (customDataIdentifierIds).

    • RECOMMENDED (default) - Use the recommended set of managed data identifiers.

    If this value is null, the job uses the recommended set of managed data identifiers.

    If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

    For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

  • 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(Option<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>

impl Client

pub fn describe_organization_configuration( &self ) -> DescribeOrganizationConfigurationFluentBuilder

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(Option<bool>):

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

  • max_account_limit_reached(Option<bool>):

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

• On failure, responds with SdkError<DescribeOrganizationConfigurationError>

impl Client

pub fn disable_macie(&self) -> DisableMacieFluentBuilder

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>

impl Client

pub fn disable_organization_admin_account( &self ) -> DisableOrganizationAdminAccountFluentBuilder

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>):
    required: true
    

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

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

impl Client

pub fn disassociate_from_administrator_account( &self ) -> DisassociateFromAdministratorAccountFluentBuilder

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>

impl Client

pub fn disassociate_from_master_account( &self ) -> DisassociateFromMasterAccountFluentBuilder

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>

impl Client

pub fn disassociate_member(&self) -> DisassociateMemberFluentBuilder

Constructs a fluent builder for the DisassociateMember operation.

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

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

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

impl Client

pub fn enable_macie(&self) -> EnableMacieFluentBuilder

Constructs a fluent builder for the EnableMacie operation.

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

    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>):
    required: false
    

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

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

    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>

impl Client

pub fn enable_organization_admin_account( &self ) -> EnableOrganizationAdminAccountFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_administrator_account(&self) -> GetAdministratorAccountFluentBuilder

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>

impl Client

pub fn get_allow_list(&self) -> GetAllowListFluentBuilder

Constructs a fluent builder for the GetAllowList operation.

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

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

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

    The Amazon Resource Name (ARN) of the allow list.

  • created_at(Option<DateTime>):

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

  • criteria(Option<AllowListCriteria>):

    The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

  • description(Option<String>):

    The custom description of the allow list.

  • id(Option<String>):

    The unique identifier for the allow list.

  • name(Option<String>):

    The custom name of the allow list.

  • status(Option<AllowListStatus>):

    The current status of the allow list, which indicates whether Amazon Macie can access and use the list’s criteria.

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

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

  • updated_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when the allow list’s settings were most recently changed in Amazon Macie.

• On failure, responds with SdkError<GetAllowListError>

impl Client

pub fn get_automated_discovery_configuration( &self ) -> GetAutomatedDiscoveryConfigurationFluentBuilder

Constructs a fluent builder for the GetAutomatedDiscoveryConfiguration operation.

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

    The unique identifier for the classification scope that’s used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.

  • disabled_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn’t enabled and subsequently disabled for the account.

  • first_enabled_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.

  • last_updated_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.

  • sensitivity_inspection_template_id(Option<String>):

    The unique identifier for the sensitivity inspection template that’s used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.

  • status(Option<AutomatedDiscoveryStatus>):

    The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don’t perform automated sensitive data discovery activities for the account.

• On failure, responds with SdkError<GetAutomatedDiscoveryConfigurationError>

impl Client

pub fn get_bucket_statistics(&self) -> GetBucketStatisticsFluentBuilder

Constructs a fluent builder for the GetBucketStatistics operation.

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

    The unique identifier for the Amazon Web Services account.

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

    The total number of buckets.

  • bucket_count_by_effective_permission(Option<BucketCountByEffectivePermission>):

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

  • bucket_count_by_encryption_type(Option<BucketCountByEncryptionType>):

    The total number of buckets whose settings do or don’t specify default server-side encryption behavior for objects that are added to the buckets.

  • 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 added to the buckets.

  • bucket_count_by_shared_access_type(Option<BucketCountBySharedAccessType>):

    The total number of buckets that are or aren’t shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs).

  • bucket_statistics_by_sensitivity(Option<BucketStatisticsBySensitivity>):

    The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.

  • classifiable_object_count(Option<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(Option<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, this value is based on the size of the latest version of each applicable object in the 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 bucket or object metadata from Amazon S3 for the buckets.

  • object_count(Option<i64>):

    The total number of objects in the buckets.

  • size_in_bytes(Option<i64>):

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

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

  • size_in_bytes_compressed(Option<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, this value is based on the size of the latest version of each applicable object in the 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>

impl Client

pub fn get_classification_export_configuration( &self ) -> GetClassificationExportConfigurationFluentBuilder

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>

impl Client

pub fn get_classification_scope(&self) -> GetClassificationScopeFluentBuilder

Constructs a fluent builder for the GetClassificationScope operation.

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

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

    
    
• On success, responds with GetClassificationScopeOutput with field(s):
  • id(Option<String>):

    The unique identifier for the classification scope.

  • name(Option<String>):

    The name of the classification scope: automated-sensitive-data-discovery.

  • s3(Option<S3ClassificationScope>):

    The S3 buckets that are excluded from automated sensitive data discovery.

• On failure, responds with SdkError<GetClassificationScopeError>

impl Client

pub fn get_custom_data_identifier(&self) -> GetCustomDataIdentifierFluentBuilder

Constructs a fluent builder for the GetCustomDataIdentifier operation.

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

    The unique identifier for the Amazon Macie resource 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(Option<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 precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren’t case sensitive.

  • maximum_match_distance(Option<i32>):

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.

  • 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 match 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>

impl Client

pub fn get_finding_statistics(&self) -> GetFindingStatisticsFluentBuilder

Constructs a fluent builder for the GetFindingStatistics operation.

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

    The criteria to use to filter the query results.

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

    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(Option<i32>):
    required: false
    

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

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

    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 matches the filter criteria specified in the request.

• On failure, responds with SdkError<GetFindingStatisticsError>

impl Client

pub fn get_findings(&self) -> GetFindingsFluentBuilder

Constructs a fluent builder for the GetFindings operation.

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

    An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

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

    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 matches the criteria specified in the request.

• On failure, responds with SdkError<GetFindingsError>

impl Client

pub fn get_findings_filter(&self) -> GetFindingsFilterFluentBuilder

Constructs a fluent builder for the GetFindingsFilter operation.

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

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

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

    The action that’s performed on findings that match 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(Option<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 specifies which tags (keys and values) are associated with the filter.

• On failure, responds with SdkError<GetFindingsFilterError>

impl Client

pub fn get_findings_publication_configuration( &self ) -> GetFindingsPublicationConfigurationFluentBuilder

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>

impl Client

pub fn get_invitations_count(&self) -> GetInvitationsCountFluentBuilder

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(Option<i64>):

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

• On failure, responds with SdkError<GetInvitationsCountError>

impl Client

pub fn get_macie_session(&self) -> GetMacieSessionFluentBuilder

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 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 or configuration settings for the Amazon Macie account.

• On failure, responds with SdkError<GetMacieSessionError>

impl Client

pub fn get_master_account(&self) -> GetMasterAccountFluentBuilder

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>

impl Client

pub fn get_member(&self) -> GetMemberFluentBuilder

Constructs a fluent builder for the GetMember operation.

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

    The unique identifier for the Amazon Macie resource 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. This value is null if the account is associated with the administrator account through Organizations.

  • 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 a Macie membership 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 specifies which tags (keys and values) are associated with the 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>

impl Client

pub fn get_resource_profile(&self) -> GetResourceProfileFluentBuilder

Constructs a fluent builder for the GetResourceProfile operation.

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

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

    
    
• On success, responds with GetResourceProfileOutput with field(s):
  • profile_updated_at(Option<DateTime>):

    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently recalculated sensitive data discovery statistics and details for the bucket. If the bucket’s sensitivity score is calculated automatically, this includes the score.

  • sensitivity_score(Option<i32>):

    The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). By default, this score is calculated automatically based on the amount of data that Amazon Macie has analyzed in the bucket and the amount of sensitive data that Macie has found in the bucket.

  • sensitivity_score_overridden(Option<bool>):

    Specifies whether the bucket’s current sensitivity score was set manually. If this value is true, the score was manually changed to 100. If this value is false, the score was calculated automatically by Amazon Macie.

  • statistics(Option<ResourceStatistics>):

    The sensitive data discovery statistics for the bucket. The statistics capture the results of automated sensitive data discovery activities that Amazon Macie has performed for the bucket.

• On failure, responds with SdkError<GetResourceProfileError>

impl Client

pub fn get_reveal_configuration(&self) -> GetRevealConfigurationFluentBuilder

Constructs a fluent builder for the GetRevealConfiguration operation.

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

    The KMS key that’s used to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.

  • retrieval_configuration(Option<RetrievalConfiguration>):

    The access method and settings that are used to retrieve the sensitive data.

• On failure, responds with SdkError<GetRevealConfigurationError>

impl Client

pub fn get_sensitive_data_occurrences( &self ) -> GetSensitiveDataOccurrencesFluentBuilder

Constructs a fluent builder for the GetSensitiveDataOccurrences operation.

• The fluent builder is configurable:
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    The unique identifier for the finding.

    
    
• On success, responds with GetSensitiveDataOccurrencesOutput with field(s):
  • error(Option<String>):

    If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.

  • sensitive_data_occurrences(Option<HashMap::<String, Vec::<DetectedDataDetails>>>):

    A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.

  • status(Option<RevealRequestStatus>):

    The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

    • ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.

    • PROCESSING - Macie is processing the request.

    • SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.

• On failure, responds with SdkError<GetSensitiveDataOccurrencesError>

impl Client

pub fn get_sensitive_data_occurrences_availability( &self ) -> GetSensitiveDataOccurrencesAvailabilityFluentBuilder

Constructs a fluent builder for the GetSensitiveDataOccurrencesAvailability operation.

• The fluent builder is configurable:
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    The unique identifier for the finding.

    
    
• On success, responds with GetSensitiveDataOccurrencesAvailabilityOutput with field(s):
  • code(Option<AvailabilityCode>):

    Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can’t be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can’t be retrieved.

  • reasons(Option<Vec::<UnavailabilityReasonCode>>):

    Specifies why occurrences of sensitive data can’t be retrieved for the finding. Possible values are:

    • ACCOUNT_NOT_IN_ORGANIZATION - The affected account isn’t currently part of your organization. Or the account is part of your organization but Macie isn’t currently enabled for the account. You’re not allowed to access the affected S3 object by using Macie.

    • INVALID_CLASSIFICATION_RESULT - There isn’t a corresponding sensitive data discovery result for the finding. Or the corresponding sensitive data discovery result isn’t available in the current Amazon Web Services Region, is malformed or corrupted, or uses an unsupported storage format. Macie can’t verify the location of the sensitive data to retrieve.

    • INVALID_RESULT_SIGNATURE - The corresponding sensitive data discovery result is stored in an S3 object that wasn’t signed by Macie. Macie can’t verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can’t verify the location of the sensitive data to retrieve.

    • MEMBER_ROLE_TOO_PERMISSIVE - The trust or permissions policy for the IAM role in the affected member account doesn’t meet Macie requirements for restricting access to the role. Or the role’s trust policy doesn’t specify the correct external ID for your organization. Macie can’t assume the role to retrieve the sensitive data.

    • MISSING_GET_MEMBER_PERMISSION - You’re not allowed to retrieve information about the association between your account and the affected account. Macie can’t determine whether you’re allowed to access the affected S3 object as the delegated Macie administrator for the affected account.

    • OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data from this type of file.

    • OBJECT_UNAVAILABLE - The affected S3 object isn’t available. The object was renamed, moved, deleted, or changed after Macie created the finding. Or the object is encrypted with an KMS key that’s currently disabled.

    • RESULT_NOT_SIGNED - The corresponding sensitive data discovery result is stored in an S3 object that hasn’t been signed. Macie can’t verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can’t verify the location of the sensitive data to retrieve.

    • ROLE_TOO_PERMISSIVE - Your account is configured to retrieve occurrences of sensitive data by using an IAM role whose trust or permissions policy doesn’t meet Macie requirements for restricting access to the role. Macie can’t assume the role to retrieve the sensitive data.

    • UNSUPPORTED_FINDING_TYPE - The specified finding isn’t a sensitive data finding.

    • UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn’t support for retrieving occurrences of sensitive data.

    This value is null if sensitive data can be retrieved for the finding.

• On failure, responds with SdkError<GetSensitiveDataOccurrencesAvailabilityError>

impl Client

pub fn get_sensitivity_inspection_template( &self ) -> GetSensitivityInspectionTemplateFluentBuilder

Constructs a fluent builder for the GetSensitivityInspectionTemplate operation.

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

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

    
    
• On success, responds with GetSensitivityInspectionTemplateOutput with field(s):
  • description(Option<String>):

    The custom description of the template.

  • excludes(Option<SensitivityInspectionTemplateExcludes>):

    The managed data identifiers that are explicitly excluded (not used) when analyzing data.

  • includes(Option<SensitivityInspectionTemplateIncludes>):

    The allow lists, custom data identifiers, and managed data identifiers that are explicitly included (used) when analyzing data.

  • name(Option<String>):

    The name of the template: automated-sensitive-data-discovery.

  • sensitivity_inspection_template_id(Option<String>):

    The unique identifier for the template.

• On failure, responds with SdkError<GetSensitivityInspectionTemplateError>

impl Client

pub fn get_usage_statistics(&self) -> GetUsageStatisticsFluentBuilder

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

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

    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(Option<i32>):
    required: false
    

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

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

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

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

    The criteria to use to sort the query results.

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

    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 matches 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>

impl Client

pub fn get_usage_totals(&self) -> GetUsageTotalsFluentBuilder

Constructs a fluent builder for the GetUsageTotals operation.

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

    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>

impl Client

pub fn list_allow_lists(&self) -> ListAllowListsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

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

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

    
    
• On success, responds with ListAllowListsOutput with field(s):
  • allow_lists(Option<Vec::<AllowListSummary>>):

    An array of objects, one for each allow list.

  • 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<ListAllowListsError>

impl Client

pub fn list_classification_jobs(&self) -> ListClassificationJobsFluentBuilder

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>):
    required: false
    

    The criteria to use to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

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

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

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

    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 matches 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>

impl Client

pub fn list_classification_scopes( &self ) -> ListClassificationScopesFluentBuilder

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

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the classification scope to retrieve the unique identifier for.

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

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

    
    
• On success, responds with ListClassificationScopesOutput with field(s):
  • classification_scopes(Option<Vec::<ClassificationScopeSummary>>):

    An array that specifies the unique identifier and name of the classification scope for 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<ListClassificationScopesError>

impl Client

pub fn list_custom_data_identifiers( &self ) -> ListCustomDataIdentifiersFluentBuilder

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(Option<i32>):
    required: false
    

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

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

    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>

impl Client

pub fn list_findings(&self) -> ListFindingsFluentBuilder

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>):
    required: false
    

    The criteria to use to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

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

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

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

    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 matches 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>

impl Client

pub fn list_findings_filters(&self) -> ListFindingsFiltersFluentBuilder

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(Option<i32>):
    required: false
    

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

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

    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>

impl Client

pub fn list_invitations(&self) -> ListInvitationsFluentBuilder

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(Option<i32>):
    required: false
    

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

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

    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>

impl Client

pub fn list_managed_data_identifiers( &self ) -> ListManagedDataIdentifiersFluentBuilder

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

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

    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>

impl Client

pub fn list_members(&self) -> ListMembersFluentBuilder

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(Option<i32>):
    required: false
    

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

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

    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>):
    required: false
    

    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 matches 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>

impl Client

pub fn list_organization_admin_accounts( &self ) -> ListOrganizationAdminAccountsFluentBuilder

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(Option<i32>):
    required: false
    

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

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

    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>

impl Client

pub fn list_resource_profile_artifacts( &self ) -> ListResourceProfileArtifactsFluentBuilder

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

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

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

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

    
    
• On success, responds with ListResourceProfileArtifactsOutput with field(s):
  • artifacts(Option<Vec::<ResourceProfileArtifact>>):

    An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected for analysis.

    If Macie has analyzed more than 100 objects in the bucket, Macie populates the array based on the value for the ResourceProfileArtifact.sensitive field for an object: true (sensitive), followed by false (not sensitive). Macie then populates any remaining items in the array with information about objects where the value for the ResourceProfileArtifact.classificationResultStatus field is SKIPPED.

  • 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<ListResourceProfileArtifactsError>

impl Client

pub fn list_resource_profile_detections( &self ) -> ListResourceProfileDetectionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

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

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

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

    
    
• On success, responds with ListResourceProfileDetectionsOutput with field(s):
  • detections(Option<Vec::<Detection>>):

    An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.

  • 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<ListResourceProfileDetectionsError>

impl Client

pub fn list_sensitivity_inspection_templates( &self ) -> ListSensitivityInspectionTemplatesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

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

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

    
    
• On success, responds with ListSensitivityInspectionTemplatesOutput 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.

  • sensitivity_inspection_templates(Option<Vec::<SensitivityInspectionTemplatesEntry>>):

    An array that specifies the unique identifier and name of the sensitivity inspection template for the account.

• On failure, responds with SdkError<ListSensitivityInspectionTemplatesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

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

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_classification_export_configuration( &self ) -> PutClassificationExportConfigurationFluentBuilder

Constructs a fluent builder for the PutClassificationExportConfiguration operation.

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

    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>

impl Client

pub fn put_findings_publication_configuration( &self ) -> PutFindingsPublicationConfigurationFluentBuilder

Constructs a fluent builder for the PutFindingsPublicationConfiguration operation.

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

    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>):
    required: false
    

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

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

impl Client

pub fn search_resources(&self) -> SearchResourcesFluentBuilder

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>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

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

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

    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 matches 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>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    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>

impl Client

pub fn test_custom_data_identifier( &self ) -> TestCustomDataIdentifierFluentBuilder

Constructs a fluent builder for the TestCustomDataIdentifier operation.

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

    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(impl Into<String>) / set_keywords(Option<Vec::<String>>):
    required: false
    

    An array that lists specific character sequences (keywords), one of which must precede and 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(Option<i32>):
    required: false
    

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

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

    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>):
    required: true
    

    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(Option<i32>):

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

• On failure, responds with SdkError<TestCustomDataIdentifierError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    One or more tags (keys) to remove from the resource. In an HTTP request to remove multiple tags, append the tagKeys parameter and argument for each tag to remove, separated by an ampersand (&).

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

impl Client

pub fn update_allow_list(&self) -> UpdateAllowListFluentBuilder

Constructs a fluent builder for the UpdateAllowList operation.

• The fluent builder is configurable:
  • criteria(AllowListCriteria) / set_criteria(Option<AllowListCriteria>):
    required: true
    

    The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex).

    You can change a list’s underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can’t change the type from s3WordsList to regex or the other way around.

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

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

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

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

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

    A custom name for the allow list. The name can contain as many as 128 characters.

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

    The Amazon Resource Name (ARN) of the allow list.

  • id(Option<String>):

    The unique identifier for the allow list.

• On failure, responds with SdkError<UpdateAllowListError>

impl Client

pub fn update_automated_discovery_configuration( &self ) -> UpdateAutomatedDiscoveryConfigurationFluentBuilder

Constructs a fluent builder for the UpdateAutomatedDiscoveryConfiguration operation.

• The fluent builder is configurable:
  • status(AutomatedDiscoveryStatus) / set_status(Option<AutomatedDiscoveryStatus>):
    required: true
    

    The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account.

    When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.

    
    
• On success, responds with UpdateAutomatedDiscoveryConfigurationOutput
• On failure, responds with SdkError<UpdateAutomatedDiscoveryConfigurationError>

impl Client

pub fn update_classification_job(&self) -> UpdateClassificationJobFluentBuilder

Constructs a fluent builder for the UpdateClassificationJob operation.

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

    The unique identifier for the classification job.

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

    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>

impl Client

pub fn update_classification_scope( &self ) -> UpdateClassificationScopeFluentBuilder

Constructs a fluent builder for the UpdateClassificationScope operation.

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

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

    
    
  • s3(S3ClassificationScopeUpdate) / set_s3(Option<S3ClassificationScopeUpdate>):
    required: false
    

    The S3 buckets to add or remove from the exclusion list defined by the classification scope.

    
    
• On success, responds with UpdateClassificationScopeOutput
• On failure, responds with SdkError<UpdateClassificationScopeError>

impl Client

pub fn update_findings_filter(&self) -> UpdateFindingsFilterFluentBuilder

Constructs a fluent builder for the UpdateFindingsFilter operation.

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

    The action to perform on findings that match 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>):
    required: false
    

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

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

    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>):
    required: false
    

    The criteria to use to filter findings.

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

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

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

    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(Option<i32>):
    required: false
    

    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.

    
    
• 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>

impl Client

pub fn update_macie_session(&self) -> UpdateMacieSessionFluentBuilder

Constructs a fluent builder for the UpdateMacieSession operation.

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

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

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

    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>

impl Client

pub fn update_member_session(&self) -> UpdateMemberSessionFluentBuilder

Constructs a fluent builder for the UpdateMemberSession operation.

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

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

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

    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>

impl Client

pub fn update_organization_configuration( &self ) -> UpdateOrganizationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateOrganizationConfiguration operation.

• The fluent builder is configurable:
  • auto_enable(bool) / set_auto_enable(Option<bool>):
    required: true
    

    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 update_resource_profile(&self) -> UpdateResourceProfileFluentBuilder

Constructs a fluent builder for the UpdateResourceProfile operation.

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

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

    
    
  • sensitivity_score_override(i32) / set_sensitivity_score_override(Option<i32>):
    required: false
    

    The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the Sensitive label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.

    
    
• On success, responds with UpdateResourceProfileOutput
• On failure, responds with SdkError<UpdateResourceProfileError>

impl Client

pub fn update_resource_profile_detections( &self ) -> UpdateResourceProfileDetectionsFluentBuilder

Constructs a fluent builder for the UpdateResourceProfileDetections operation.

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

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

    
    
  • suppress_data_identifiers(SuppressDataIdentifier) / set_suppress_data_identifiers(Option<Vec::<SuppressDataIdentifier>>):
    required: false
    

    An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket’s score. To start including all sensitive data types in the score, don’t specify any values for this array.

    
    
• On success, responds with UpdateResourceProfileDetectionsOutput
• On failure, responds with SdkError<UpdateResourceProfileDetectionsError>

impl Client

pub fn update_reveal_configuration( &self ) -> UpdateRevealConfigurationFluentBuilder

Constructs a fluent builder for the UpdateRevealConfiguration operation.

• The fluent builder is configurable:
  • configuration(RevealConfiguration) / set_configuration(Option<RevealConfiguration>):
    required: true
    

    The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.

    
    
  • retrieval_configuration(UpdateRetrievalConfiguration) / set_retrieval_configuration(Option<UpdateRetrievalConfiguration>):
    required: false
    

    The access method and settings to use when retrieving the sensitive data.

    
    
• On success, responds with UpdateRevealConfigurationOutput with field(s):
  • configuration(Option<RevealConfiguration>):

    The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.

  • retrieval_configuration(Option<RetrievalConfiguration>):

    The access method and settings to use when retrieving the sensitive data.

• On failure, responds with SdkError<UpdateRevealConfigurationError>

impl Client

pub fn update_sensitivity_inspection_template( &self ) -> UpdateSensitivityInspectionTemplateFluentBuilder

Constructs a fluent builder for the UpdateSensitivityInspectionTemplate operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

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

    
    
  • excludes(SensitivityInspectionTemplateExcludes) / set_excludes(Option<SensitivityInspectionTemplateExcludes>):
    required: false
    

    The managed data identifiers to explicitly exclude (not use) when analyzing data.

    To exclude an allow list or custom data identifier that’s currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.

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

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

    
    
  • includes(SensitivityInspectionTemplateIncludes) / set_includes(Option<SensitivityInspectionTemplateIncludes>):
    required: false
    

    The allow lists, custom data identifiers, and managed data identifiers to explicitly include (use) when analyzing data.

    
    
• On success, responds with UpdateSensitivityInspectionTemplateOutput
• On failure, responds with SdkError<UpdateSensitivityInspectionTemplateError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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 Waiters for Client

fn wait_until_finding_revealed(&self) -> FindingRevealedFluentBuilder

Wait until the sensitive data occurrences are ready.