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.
434 435 436 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 434 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.
463 464 465 466 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 463 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.
499 500 501 502 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 499 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.
534 535 536 537 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 534 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.
590 591 592 593 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 590 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.
776 777 778 779 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 776 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.
853 854 855 856 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 853 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.
924 925 926 927 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 924 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.
960 961 962 963 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 960 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.
999 1000 1001 1002 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 999 def create_member(params = {}, = {}) req = build_request(:create_member, params) req.send_request() end |
#create_sample_findings(params = {}) ⇒ Struct
Creates sample findings.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1020 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.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1051 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_allow_list(params = {}) ⇒ Struct
Deletes an allow list.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1075 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.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1096 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.
1117 1118 1119 1120 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1117 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1148 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.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1170 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.
1285 1286 1287 1288 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1285 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1403 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.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1425 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1439 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.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1461 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1475 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.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1492 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.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1514 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1554 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.
1581 1582 1583 1584 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1581 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.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1604 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.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1651 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1683 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.
1767 1768 1769 1770 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1767 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.
1789 1790 1791 1792 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1789 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1821 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.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1876 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.
1933 1934 1935 1936 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1933 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.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2139 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.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2191 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.
2212 2213 2214 2215 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2212 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.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2232 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.
2260 2261 2262 2263 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2260 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.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2286 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2331 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.
2373 2374 2375 2376 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2373 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.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2398 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
2436 2437 2438 2439 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2436 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.
2467 2468 2469 2470 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2467 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.
2509 2510 2511 2512 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2509 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.
2578 2579 2580 2581 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2578 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.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2610 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.
2651 2652 2653 2654 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2651 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.
2691 2692 2693 2694 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2691 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.
2785 2786 2787 2788 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2785 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.
2822 2823 2824 2825 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2822 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.
2862 2863 2864 2865 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2862 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.
2921 2922 2923 2924 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2921 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.
2962 2963 2964 2965 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2962 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.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3001 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.
3035 3036 3037 3038 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3035 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.
3083 3084 3085 3086 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3083 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.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3120 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.
3158 3159 3160 3161 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3158 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.
3202 3203 3204 3205 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3202 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.
3239 3240 3241 3242 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3239 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.
3268 3269 3270 3271 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3268 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.
3307 3308 3309 3310 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3307 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.
3345 3346 3347 3348 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3345 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.
3463 3464 3465 3466 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3463 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.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3492 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.
3531 3532 3533 3534 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3531 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.
3556 3557 3558 3559 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3556 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.
3603 3604 3605 3606 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3603 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.
3634 3635 3636 3637 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3634 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.
3659 3660 3661 3662 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3659 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.
3690 3691 3692 3693 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3690 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.
3756 3757 3758 3759 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3756 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.
3791 3792 3793 3794 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3791 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.
3817 3818 3819 3820 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3817 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.
3839 3840 3841 3842 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3839 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.
3863 3864 3865 3866 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3863 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.
3892 3893 3894 3895 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3892 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.
3951 3952 3953 3954 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3951 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.
4006 4007 4008 4009 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 4006 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 |
4121 4122 4123 4124 4125 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 4121 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |