Class: Aws::Macie2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Macie2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb
Overview
An API client for Macie2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Macie2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_invitation(params = {}) ⇒ Struct
Accepts an Amazon Macie membership invitation that was received from a specific account.
-
#batch_get_custom_data_identifiers(params = {}) ⇒ Types::BatchGetCustomDataIdentifiersResponse
Retrieves information about one or more custom data identifiers.
-
#batch_update_automated_discovery_accounts(params = {}) ⇒ Types::BatchUpdateAutomatedDiscoveryAccountsResponse
Changes the status of automated sensitive data discovery for one or more accounts.
-
#create_allow_list(params = {}) ⇒ Types::CreateAllowListResponse
Creates and defines the settings for an allow list.
-
#create_classification_job(params = {}) ⇒ Types::CreateClassificationJobResponse
Creates and defines the settings for a classification job.
-
#create_custom_data_identifier(params = {}) ⇒ Types::CreateCustomDataIdentifierResponse
Creates and defines the criteria and other settings for a custom data identifier.
-
#create_findings_filter(params = {}) ⇒ Types::CreateFindingsFilterResponse
Creates and defines the criteria and other settings for a findings filter.
-
#create_invitations(params = {}) ⇒ Types::CreateInvitationsResponse
Sends an Amazon Macie membership invitation to one or more accounts.
-
#create_member(params = {}) ⇒ Types::CreateMemberResponse
Associates an account with an Amazon Macie administrator account.
-
#create_sample_findings(params = {}) ⇒ Struct
Creates sample findings.
-
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines Amazon Macie membership invitations that were received from specific accounts.
-
#delete_allow_list(params = {}) ⇒ Struct
Deletes an allow list.
-
#delete_custom_data_identifier(params = {}) ⇒ Struct
Soft deletes a custom data identifier.
-
#delete_findings_filter(params = {}) ⇒ Struct
Deletes a findings filter.
-
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes Amazon Macie membership invitations that were received from specific accounts.
-
#delete_member(params = {}) ⇒ Struct
Deletes the association between an Amazon Macie administrator account and an account.
-
#describe_buckets(params = {}) ⇒ Types::DescribeBucketsResponse
Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.
-
#describe_classification_job(params = {}) ⇒ Types::DescribeClassificationJobResponse
Retrieves the status and settings for a classification job.
-
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Retrieves the Amazon Macie configuration settings for an organization in Organizations.
-
#disable_macie(params = {}) ⇒ Struct
Disables Amazon Macie and deletes all settings and resources for a Macie account.
-
#disable_organization_admin_account(params = {}) ⇒ Struct
Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
-
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates a member account from its Amazon Macie administrator account.
-
#disassociate_from_master_account(params = {}) ⇒ Struct
(Deprecated) Disassociates a member account from its Amazon Macie administrator account.
-
#disassociate_member(params = {}) ⇒ Struct
Disassociates an Amazon Macie administrator account from a member account.
-
#enable_macie(params = {}) ⇒ Struct
Enables Amazon Macie and specifies the configuration settings for a Macie account.
-
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
-
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Retrieves information about the Amazon Macie administrator account for an account.
-
#get_allow_list(params = {}) ⇒ Types::GetAllowListResponse
Retrieves the settings and status of an allow list.
-
#get_automated_discovery_configuration(params = {}) ⇒ Types::GetAutomatedDiscoveryConfigurationResponse
Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
-
#get_bucket_statistics(params = {}) ⇒ Types::GetBucketStatisticsResponse
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
-
#get_classification_export_configuration(params = {}) ⇒ Types::GetClassificationExportConfigurationResponse
Retrieves the configuration settings for storing data classification results.
-
#get_classification_scope(params = {}) ⇒ Types::GetClassificationScopeResponse
Retrieves the classification scope settings for an account.
-
#get_custom_data_identifier(params = {}) ⇒ Types::GetCustomDataIdentifierResponse
Retrieves the criteria and other settings for a custom data identifier.
-
#get_finding_statistics(params = {}) ⇒ Types::GetFindingStatisticsResponse
Retrieves (queries) aggregated statistical data about findings.
-
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Retrieves the details of one or more findings.
-
#get_findings_filter(params = {}) ⇒ Types::GetFindingsFilterResponse
Retrieves the criteria and other settings for a findings filter.
-
#get_findings_publication_configuration(params = {}) ⇒ Types::GetFindingsPublicationConfigurationResponse
Retrieves the configuration settings for publishing findings to Security Hub.
-
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Retrieves the count of Amazon Macie membership invitations that were received by an account.
-
#get_macie_session(params = {}) ⇒ Types::GetMacieSessionResponse
Retrieves the status and configuration settings for an Amazon Macie account.
-
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
(Deprecated) Retrieves information about the Amazon Macie administrator account for an account.
-
#get_member(params = {}) ⇒ Types::GetMemberResponse
Retrieves information about an account that's associated with an Amazon Macie administrator account.
-
#get_resource_profile(params = {}) ⇒ Types::GetResourceProfileResponse
Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.
-
#get_reveal_configuration(params = {}) ⇒ Types::GetRevealConfigurationResponse
Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
-
#get_sensitive_data_occurrences(params = {}) ⇒ Types::GetSensitiveDataOccurrencesResponse
Retrieves occurrences of sensitive data reported by a finding.
-
#get_sensitive_data_occurrences_availability(params = {}) ⇒ Types::GetSensitiveDataOccurrencesAvailabilityResponse
Checks whether occurrences of sensitive data can be retrieved for a finding.
-
#get_sensitivity_inspection_template(params = {}) ⇒ Types::GetSensitivityInspectionTemplateResponse
Retrieves the settings for the sensitivity inspection template for an account.
-
#get_usage_statistics(params = {}) ⇒ Types::GetUsageStatisticsResponse
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
-
#get_usage_totals(params = {}) ⇒ Types::GetUsageTotalsResponse
Retrieves (queries) aggregated usage data for an account.
-
#list_allow_lists(params = {}) ⇒ Types::ListAllowListsResponse
Retrieves a subset of information about all the allow lists for an account.
-
#list_automated_discovery_accounts(params = {}) ⇒ Types::ListAutomatedDiscoveryAccountsResponse
Retrieves the status of automated sensitive data discovery for one or more accounts.
-
#list_classification_jobs(params = {}) ⇒ Types::ListClassificationJobsResponse
Retrieves a subset of information about one or more classification jobs.
-
#list_classification_scopes(params = {}) ⇒ Types::ListClassificationScopesResponse
Retrieves a subset of information about the classification scope for an account.
-
#list_custom_data_identifiers(params = {}) ⇒ Types::ListCustomDataIdentifiersResponse
Retrieves a subset of information about all the custom data identifiers for an account.
-
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Retrieves a subset of information about one or more findings.
-
#list_findings_filters(params = {}) ⇒ Types::ListFindingsFiltersResponse
Retrieves a subset of information about all the findings filters for an account.
-
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Retrieves information about Amazon Macie membership invitations that were received by an account.
-
#list_managed_data_identifiers(params = {}) ⇒ Types::ListManagedDataIdentifiersResponse
Retrieves information about all the managed data identifiers that Amazon Macie currently provides.
-
#list_members(params = {}) ⇒ Types::ListMembersResponse
Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
-
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
-
#list_resource_profile_artifacts(params = {}) ⇒ Types::ListResourceProfileArtifactsResponse
Retrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery.
-
#list_resource_profile_detections(params = {}) ⇒ Types::ListResourceProfileDetectionsResponse
Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.
-
#list_sensitivity_inspection_templates(params = {}) ⇒ Types::ListSensitivityInspectionTemplatesResponse
Retrieves a subset of information about the sensitivity inspection template for an account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.
-
#put_classification_export_configuration(params = {}) ⇒ Types::PutClassificationExportConfigurationResponse
Adds or updates the configuration settings for storing data classification results.
-
#put_findings_publication_configuration(params = {}) ⇒ Struct
Updates the configuration settings for publishing findings to Security Hub.
-
#search_resources(params = {}) ⇒ Types::SearchResourcesResponse
Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.
-
#test_custom_data_identifier(params = {}) ⇒ Types::TestCustomDataIdentifierResponse
Tests criteria for a custom data identifier.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags (keys and values) from an Amazon Macie resource.
-
#update_allow_list(params = {}) ⇒ Types::UpdateAllowListResponse
Updates the settings for an allow list.
-
#update_automated_discovery_configuration(params = {}) ⇒ Struct
Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
-
#update_classification_job(params = {}) ⇒ Struct
Changes the status of a classification job.
-
#update_classification_scope(params = {}) ⇒ Struct
Updates the classification scope settings for an account.
-
#update_findings_filter(params = {}) ⇒ Types::UpdateFindingsFilterResponse
Updates the criteria and other settings for a findings filter.
-
#update_macie_session(params = {}) ⇒ Struct
Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
-
#update_member_session(params = {}) ⇒ Struct
Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
-
#update_organization_configuration(params = {}) ⇒ Struct
Updates the Amazon Macie configuration settings for an organization in Organizations.
-
#update_resource_profile(params = {}) ⇒ Struct
Updates the sensitivity score for an S3 bucket.
-
#update_resource_profile_detections(params = {}) ⇒ Struct
Updates the sensitivity scoring settings for an S3 bucket.
-
#update_reveal_configuration(params = {}) ⇒ Types::UpdateRevealConfigurationResponse
Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
-
#update_sensitivity_inspection_template(params = {}) ⇒ Struct
Updates the settings for the sensitivity inspection template for an account.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#accept_invitation(params = {}) ⇒ Struct
Accepts an Amazon Macie membership invitation that was received from a specific account.
439 440 441 442 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 439 def accept_invitation(params = {}, = {}) req = build_request(:accept_invitation, params) req.send_request() end |
#batch_get_custom_data_identifiers(params = {}) ⇒ Types::BatchGetCustomDataIdentifiersResponse
Retrieves information about one or more custom data identifiers.
475 476 477 478 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 475 def batch_get_custom_data_identifiers(params = {}, = {}) req = build_request(:batch_get_custom_data_identifiers, params) req.send_request() end |
#batch_update_automated_discovery_accounts(params = {}) ⇒ Types::BatchUpdateAutomatedDiscoveryAccountsResponse
Changes the status of automated sensitive data discovery for one or more accounts.
510 511 512 513 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 510 def batch_update_automated_discovery_accounts(params = {}, = {}) req = build_request(:batch_update_automated_discovery_accounts, params) req.send_request() end |
#create_allow_list(params = {}) ⇒ Types::CreateAllowListResponse
Creates and defines the settings for an allow list.
566 567 568 569 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 566 def create_allow_list(params = {}, = {}) req = build_request(:create_allow_list, params) req.send_request() end |
#create_classification_job(params = {}) ⇒ Types::CreateClassificationJobResponse
Creates and defines the settings for a classification job.
752 753 754 755 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 752 def create_classification_job(params = {}, = {}) req = build_request(:create_classification_job, params) req.send_request() end |
#create_custom_data_identifier(params = {}) ⇒ Types::CreateCustomDataIdentifierResponse
Creates and defines the criteria and other settings for a custom data identifier.
829 830 831 832 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 829 def create_custom_data_identifier(params = {}, = {}) req = build_request(:create_custom_data_identifier, params) req.send_request() end |
#create_findings_filter(params = {}) ⇒ Types::CreateFindingsFilterResponse
Creates and defines the criteria and other settings for a findings filter.
900 901 902 903 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 900 def create_findings_filter(params = {}, = {}) req = build_request(:create_findings_filter, params) req.send_request() end |
#create_invitations(params = {}) ⇒ Types::CreateInvitationsResponse
Sends an Amazon Macie membership invitation to one or more accounts.
936 937 938 939 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 936 def create_invitations(params = {}, = {}) req = build_request(:create_invitations, params) req.send_request() end |
#create_member(params = {}) ⇒ Types::CreateMemberResponse
Associates an account with an Amazon Macie administrator account.
975 976 977 978 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 975 def create_member(params = {}, = {}) req = build_request(:create_member, params) req.send_request() end |
#create_sample_findings(params = {}) ⇒ Struct
Creates sample findings.
996 997 998 999 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 996 def create_sample_findings(params = {}, = {}) req = build_request(:create_sample_findings, params) req.send_request() end |
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines Amazon Macie membership invitations that were received from specific accounts.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1027 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_allow_list(params = {}) ⇒ Struct
Deletes an allow list.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1051 def delete_allow_list(params = {}, = {}) req = build_request(:delete_allow_list, params) req.send_request() end |
#delete_custom_data_identifier(params = {}) ⇒ Struct
Soft deletes a custom data identifier.
1072 1073 1074 1075 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1072 def delete_custom_data_identifier(params = {}, = {}) req = build_request(:delete_custom_data_identifier, params) req.send_request() end |
#delete_findings_filter(params = {}) ⇒ Struct
Deletes a findings filter.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1093 def delete_findings_filter(params = {}, = {}) req = build_request(:delete_findings_filter, params) req.send_request() end |
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes Amazon Macie membership invitations that were received from specific accounts.
1124 1125 1126 1127 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1124 def delete_invitations(params = {}, = {}) req = build_request(:delete_invitations, params) req.send_request() end |
#delete_member(params = {}) ⇒ Struct
Deletes the association between an Amazon Macie administrator account and an account.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1146 def delete_member(params = {}, = {}) req = build_request(:delete_member, params) req.send_request() end |
#describe_buckets(params = {}) ⇒ Types::DescribeBucketsResponse
Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1261 def describe_buckets(params = {}, = {}) req = build_request(:describe_buckets, params) req.send_request() end |
#describe_classification_job(params = {}) ⇒ Types::DescribeClassificationJobResponse
Retrieves the status and settings for a classification job.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1379 def describe_classification_job(params = {}, = {}) req = build_request(:describe_classification_job, params) req.send_request() end |
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Retrieves the Amazon Macie configuration settings for an organization in Organizations.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1401 def describe_organization_configuration(params = {}, = {}) req = build_request(:describe_organization_configuration, params) req.send_request() end |
#disable_macie(params = {}) ⇒ Struct
Disables Amazon Macie and deletes all settings and resources for a Macie account.
1415 1416 1417 1418 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1415 def disable_macie(params = {}, = {}) req = build_request(:disable_macie, params) req.send_request() end |
#disable_organization_admin_account(params = {}) ⇒ Struct
Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1437 def disable_organization_admin_account(params = {}, = {}) req = build_request(:disable_organization_admin_account, params) req.send_request() end |
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates a member account from its Amazon Macie administrator account.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1451 def disassociate_from_administrator_account(params = {}, = {}) req = build_request(:disassociate_from_administrator_account, params) req.send_request() end |
#disassociate_from_master_account(params = {}) ⇒ Struct
(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the
DisassociateFromAdministratorAccount operation.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1468 def disassociate_from_master_account(params = {}, = {}) req = build_request(:disassociate_from_master_account, params) req.send_request() end |
#disassociate_member(params = {}) ⇒ Struct
Disassociates an Amazon Macie administrator account from a member account.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1490 def disassociate_member(params = {}, = {}) req = build_request(:disassociate_member, params) req.send_request() end |
#enable_macie(params = {}) ⇒ Struct
Enables Amazon Macie and specifies the configuration settings for a Macie account.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1530 def enable_macie(params = {}, = {}) req = build_request(:enable_macie, params) req.send_request() end |
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1557 def enable_organization_admin_account(params = {}, = {}) req = build_request(:enable_organization_admin_account, params) req.send_request() end |
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Retrieves information about the Amazon Macie administrator account for an account.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1580 def get_administrator_account(params = {}, = {}) req = build_request(:get_administrator_account, params) req.send_request() end |
#get_allow_list(params = {}) ⇒ Types::GetAllowListResponse
Retrieves the settings and status of an allow list.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1627 def get_allow_list(params = {}, = {}) req = build_request(:get_allow_list, params) req.send_request() end |
#get_automated_discovery_configuration(params = {}) ⇒ Types::GetAutomatedDiscoveryConfigurationResponse
Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1659 def get_automated_discovery_configuration(params = {}, = {}) req = build_request(:get_automated_discovery_configuration, params) req.send_request() end |
#get_bucket_statistics(params = {}) ⇒ Types::GetBucketStatisticsResponse
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1743 def get_bucket_statistics(params = {}, = {}) req = build_request(:get_bucket_statistics, params) req.send_request() end |
#get_classification_export_configuration(params = {}) ⇒ Types::GetClassificationExportConfigurationResponse
Retrieves the configuration settings for storing data classification results.
1765 1766 1767 1768 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1765 def get_classification_export_configuration(params = {}, = {}) req = build_request(:get_classification_export_configuration, params) req.send_request() end |
#get_classification_scope(params = {}) ⇒ Types::GetClassificationScopeResponse
Retrieves the classification scope settings for an account.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1797 def get_classification_scope(params = {}, = {}) req = build_request(:get_classification_scope, params) req.send_request() end |
#get_custom_data_identifier(params = {}) ⇒ Types::GetCustomDataIdentifierResponse
Retrieves the criteria and other settings for a custom data identifier.
1852 1853 1854 1855 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1852 def get_custom_data_identifier(params = {}, = {}) req = build_request(:get_custom_data_identifier, params) req.send_request() end |
#get_finding_statistics(params = {}) ⇒ Types::GetFindingStatisticsResponse
Retrieves (queries) aggregated statistical data about findings.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1909 def get_finding_statistics(params = {}, = {}) req = build_request(:get_finding_statistics, params) req.send_request() end |
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Retrieves the details of one or more findings.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2115 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_findings_filter(params = {}) ⇒ Types::GetFindingsFilterResponse
Retrieves the criteria and other settings for a findings filter.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2167 def get_findings_filter(params = {}, = {}) req = build_request(:get_findings_filter, params) req.send_request() end |
#get_findings_publication_configuration(params = {}) ⇒ Types::GetFindingsPublicationConfigurationResponse
Retrieves the configuration settings for publishing findings to Security Hub.
2188 2189 2190 2191 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2188 def get_findings_publication_configuration(params = {}, = {}) req = build_request(:get_findings_publication_configuration, params) req.send_request() end |
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Retrieves the count of Amazon Macie membership invitations that were received by an account.
2208 2209 2210 2211 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2208 def get_invitations_count(params = {}, = {}) req = build_request(:get_invitations_count, params) req.send_request() end |
#get_macie_session(params = {}) ⇒ Types::GetMacieSessionResponse
Retrieves the status and configuration settings for an Amazon Macie account.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2236 def get_macie_session(params = {}, = {}) req = build_request(:get_macie_session, params) req.send_request() end |
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the
GetAdministratorAccount operation.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2262 def get_master_account(params = {}, = {}) req = build_request(:get_master_account, params) req.send_request() end |
#get_member(params = {}) ⇒ Types::GetMemberResponse
Retrieves information about an account that's associated with an Amazon Macie administrator account.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2307 def get_member(params = {}, = {}) req = build_request(:get_member, params) req.send_request() end |
#get_resource_profile(params = {}) ⇒ Types::GetResourceProfileResponse
Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.
2349 2350 2351 2352 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2349 def get_resource_profile(params = {}, = {}) req = build_request(:get_resource_profile, params) req.send_request() end |
#get_reveal_configuration(params = {}) ⇒ Types::GetRevealConfigurationResponse
Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
2374 2375 2376 2377 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2374 def get_reveal_configuration(params = {}, = {}) req = build_request(:get_reveal_configuration, params) req.send_request() end |
#get_sensitive_data_occurrences(params = {}) ⇒ Types::GetSensitiveDataOccurrencesResponse
Retrieves occurrences of sensitive data reported by a finding.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- finding_revealed
2412 2413 2414 2415 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2412 def get_sensitive_data_occurrences(params = {}, = {}) req = build_request(:get_sensitive_data_occurrences, params) req.send_request() end |
#get_sensitive_data_occurrences_availability(params = {}) ⇒ Types::GetSensitiveDataOccurrencesAvailabilityResponse
Checks whether occurrences of sensitive data can be retrieved for a finding.
2443 2444 2445 2446 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2443 def get_sensitive_data_occurrences_availability(params = {}, = {}) req = build_request(:get_sensitive_data_occurrences_availability, params) req.send_request() end |
#get_sensitivity_inspection_template(params = {}) ⇒ Types::GetSensitivityInspectionTemplateResponse
Retrieves the settings for the sensitivity inspection template for an account.
2485 2486 2487 2488 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2485 def get_sensitivity_inspection_template(params = {}, = {}) req = build_request(:get_sensitivity_inspection_template, params) req.send_request() end |
#get_usage_statistics(params = {}) ⇒ Types::GetUsageStatisticsResponse
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2554 2555 2556 2557 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2554 def get_usage_statistics(params = {}, = {}) req = build_request(:get_usage_statistics, params) req.send_request() end |
#get_usage_totals(params = {}) ⇒ Types::GetUsageTotalsResponse
Retrieves (queries) aggregated usage data for an account.
2586 2587 2588 2589 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2586 def get_usage_totals(params = {}, = {}) req = build_request(:get_usage_totals, params) req.send_request() end |
#list_allow_lists(params = {}) ⇒ Types::ListAllowListsResponse
Retrieves a subset of information about all the allow lists for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2627 2628 2629 2630 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2627 def list_allow_lists(params = {}, = {}) req = build_request(:list_allow_lists, params) req.send_request() end |
#list_automated_discovery_accounts(params = {}) ⇒ Types::ListAutomatedDiscoveryAccountsResponse
Retrieves the status of automated sensitive data discovery for one or more accounts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2667 2668 2669 2670 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2667 def list_automated_discovery_accounts(params = {}, = {}) req = build_request(:list_automated_discovery_accounts, params) req.send_request() end |
#list_classification_jobs(params = {}) ⇒ Types::ListClassificationJobsResponse
Retrieves a subset of information about one or more classification jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2761 2762 2763 2764 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2761 def list_classification_jobs(params = {}, = {}) req = build_request(:list_classification_jobs, params) req.send_request() end |
#list_classification_scopes(params = {}) ⇒ Types::ListClassificationScopesResponse
Retrieves a subset of information about the classification scope for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2798 def list_classification_scopes(params = {}, = {}) req = build_request(:list_classification_scopes, params) req.send_request() end |
#list_custom_data_identifiers(params = {}) ⇒ Types::ListCustomDataIdentifiersResponse
Retrieves a subset of information about all the custom data identifiers for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2838 def list_custom_data_identifiers(params = {}, = {}) req = build_request(:list_custom_data_identifiers, params) req.send_request() end |
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Retrieves a subset of information about one or more findings.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2897 def list_findings(params = {}, = {}) req = build_request(:list_findings, params) req.send_request() end |
#list_findings_filters(params = {}) ⇒ Types::ListFindingsFiltersResponse
Retrieves a subset of information about all the findings filters for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2938 2939 2940 2941 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2938 def list_findings_filters(params = {}, = {}) req = build_request(:list_findings_filters, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Retrieves information about Amazon Macie membership invitations that were received by an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2977 2978 2979 2980 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2977 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |
#list_managed_data_identifiers(params = {}) ⇒ Types::ListManagedDataIdentifiersResponse
Retrieves information about all the managed data identifiers that Amazon Macie currently provides.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3011 def list_managed_data_identifiers(params = {}, = {}) req = build_request(:list_managed_data_identifiers, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersResponse
Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3059 3060 3061 3062 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3059 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3096 def list_organization_admin_accounts(params = {}, = {}) req = build_request(:list_organization_admin_accounts, params) req.send_request() end |
#list_resource_profile_artifacts(params = {}) ⇒ Types::ListResourceProfileArtifactsResponse
Retrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3134 def list_resource_profile_artifacts(params = {}, = {}) req = build_request(:list_resource_profile_artifacts, params) req.send_request() end |
#list_resource_profile_detections(params = {}) ⇒ Types::ListResourceProfileDetectionsResponse
Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3178 3179 3180 3181 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3178 def list_resource_profile_detections(params = {}, = {}) req = build_request(:list_resource_profile_detections, params) req.send_request() end |
#list_sensitivity_inspection_templates(params = {}) ⇒ Types::ListSensitivityInspectionTemplatesResponse
Retrieves a subset of information about the sensitivity inspection template for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3215 3216 3217 3218 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3215 def list_sensitivity_inspection_templates(params = {}, = {}) req = build_request(:list_sensitivity_inspection_templates, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3244 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_classification_export_configuration(params = {}) ⇒ Types::PutClassificationExportConfigurationResponse
Adds or updates the configuration settings for storing data classification results.
3283 3284 3285 3286 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3283 def put_classification_export_configuration(params = {}, = {}) req = build_request(:put_classification_export_configuration, params) req.send_request() end |
#put_findings_publication_configuration(params = {}) ⇒ Struct
Updates the configuration settings for publishing findings to Security Hub.
3321 3322 3323 3324 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3321 def put_findings_publication_configuration(params = {}, = {}) req = build_request(:put_findings_publication_configuration, params) req.send_request() end |
#search_resources(params = {}) ⇒ Types::SearchResourcesResponse
Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3439 3440 3441 3442 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3439 def search_resources(params = {}, = {}) req = build_request(:search_resources, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.
3468 3469 3470 3471 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3468 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_custom_data_identifier(params = {}) ⇒ Types::TestCustomDataIdentifierResponse
Tests criteria for a custom data identifier.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3507 def test_custom_data_identifier(params = {}, = {}) req = build_request(:test_custom_data_identifier, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags (keys and values) from an Amazon Macie resource.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3532 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_allow_list(params = {}) ⇒ Types::UpdateAllowListResponse
Updates the settings for an allow list.
3579 3580 3581 3582 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3579 def update_allow_list(params = {}, = {}) req = build_request(:update_allow_list, params) req.send_request() end |
#update_automated_discovery_configuration(params = {}) ⇒ Struct
Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
3610 3611 3612 3613 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3610 def update_automated_discovery_configuration(params = {}, = {}) req = build_request(:update_automated_discovery_configuration, params) req.send_request() end |
#update_classification_job(params = {}) ⇒ Struct
Changes the status of a classification job.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3635 def update_classification_job(params = {}, = {}) req = build_request(:update_classification_job, params) req.send_request() end |
#update_classification_scope(params = {}) ⇒ Struct
Updates the classification scope settings for an account.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3666 def update_classification_scope(params = {}, = {}) req = build_request(:update_classification_scope, params) req.send_request() end |
#update_findings_filter(params = {}) ⇒ Types::UpdateFindingsFilterResponse
Updates the criteria and other settings for a findings filter.
3732 3733 3734 3735 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3732 def update_findings_filter(params = {}, = {}) req = build_request(:update_findings_filter, params) req.send_request() end |
#update_macie_session(params = {}) ⇒ Struct
Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
3767 3768 3769 3770 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3767 def update_macie_session(params = {}, = {}) req = build_request(:update_macie_session, params) req.send_request() end |
#update_member_session(params = {}) ⇒ Struct
Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
3793 3794 3795 3796 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3793 def update_member_session(params = {}, = {}) req = build_request(:update_member_session, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Struct
Updates the Amazon Macie configuration settings for an organization in Organizations.
3815 3816 3817 3818 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3815 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |
#update_resource_profile(params = {}) ⇒ Struct
Updates the sensitivity score for an S3 bucket.
3839 3840 3841 3842 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3839 def update_resource_profile(params = {}, = {}) req = build_request(:update_resource_profile, params) req.send_request() end |
#update_resource_profile_detections(params = {}) ⇒ Struct
Updates the sensitivity scoring settings for an S3 bucket.
3868 3869 3870 3871 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3868 def update_resource_profile_detections(params = {}, = {}) req = build_request(:update_resource_profile_detections, params) req.send_request() end |
#update_reveal_configuration(params = {}) ⇒ Types::UpdateRevealConfigurationResponse
Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3927 def update_reveal_configuration(params = {}, = {}) req = build_request(:update_reveal_configuration, params) req.send_request() end |
#update_sensitivity_inspection_template(params = {}) ⇒ Struct
Updates the settings for the sensitivity inspection template for an account.
3982 3983 3984 3985 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3982 def update_sensitivity_inspection_template(params = {}, = {}) req = build_request(:update_sensitivity_inspection_template, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
finding_revealed | #get_sensitive_data_occurrences | 2 | 60 |
4092 4093 4094 4095 4096 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 4092 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |