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.
-
#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 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_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 the 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 were 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
Creates 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 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
Enables or disables automated sensitive data discovery for an 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.
385 386 387 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 385 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.
414 415 416 417 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 414 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.
450 451 452 453 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 450 def batch_get_custom_data_identifiers(params = {}, = {}) req = build_request(:batch_get_custom_data_identifiers, params) req.send_request() end |
#create_allow_list(params = {}) ⇒ Types::CreateAllowListResponse
Creates and defines the settings for an allow list.
506 507 508 509 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 506 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.
692 693 694 695 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 692 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.
769 770 771 772 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 769 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.
840 841 842 843 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 840 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.
876 877 878 879 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 876 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.
915 916 917 918 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 915 def create_member(params = {}, = {}) req = build_request(:create_member, params) req.send_request() end |
#create_sample_findings(params = {}) ⇒ Struct
Creates sample findings.
936 937 938 939 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 936 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.
967 968 969 970 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 967 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_allow_list(params = {}) ⇒ Struct
Deletes an allow list.
991 992 993 994 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 991 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.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1012 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.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1033 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.
1064 1065 1066 1067 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1064 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.
1086 1087 1088 1089 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1086 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.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1200 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.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1318 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.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1340 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1354 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.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1376 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1390 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.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1407 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.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1429 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.
1469 1470 1471 1472 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1469 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.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1496 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.
1519 1520 1521 1522 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1519 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1566 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 account.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1596 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.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1680 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1702 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.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1734 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.
1789 1790 1791 1792 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1789 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.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 1846 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.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2052 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.
2104 2105 2106 2107 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2104 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.
2125 2126 2127 2128 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2125 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.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2145 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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2173 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.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2199 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.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2244 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.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2286 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.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2311 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
2349 2350 2351 2352 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2349 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.
2380 2381 2382 2383 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2380 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.
2422 2423 2424 2425 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2422 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.
2491 2492 2493 2494 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2491 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.
2523 2524 2525 2526 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2523 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.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2564 def list_allow_lists(params = {}, = {}) req = build_request(:list_allow_lists, 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.
2658 2659 2660 2661 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2658 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.
2695 2696 2697 2698 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2695 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.
2735 2736 2737 2738 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2735 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.
2794 2795 2796 2797 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2794 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.
2835 2836 2837 2838 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2835 def list_findings_filters(params = {}, = {}) req = build_request(:list_findings_filters, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Retrieves information about the 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2874 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.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2908 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.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2956 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.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 2993 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 were 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.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3031 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.
3075 3076 3077 3078 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3075 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.
3112 3113 3114 3115 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3112 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.
3141 3142 3143 3144 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3141 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_classification_export_configuration(params = {}) ⇒ Types::PutClassificationExportConfigurationResponse
Creates or updates the configuration settings for storing data classification results.
3180 3181 3182 3183 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3180 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.
3218 3219 3220 3221 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3218 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.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3335 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.
3364 3365 3366 3367 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3364 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_custom_data_identifier(params = {}) ⇒ Types::TestCustomDataIdentifierResponse
Tests a custom data identifier.
3403 3404 3405 3406 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3403 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.
3428 3429 3430 3431 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3428 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.
3475 3476 3477 3478 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3475 def update_allow_list(params = {}, = {}) req = build_request(:update_allow_list, params) req.send_request() end |
#update_automated_discovery_configuration(params = {}) ⇒ Struct
Enables or disables automated sensitive data discovery for an account.
3498 3499 3500 3501 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3498 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.
3523 3524 3525 3526 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3523 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.
3554 3555 3556 3557 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3554 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.
3620 3621 3622 3623 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3620 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.
3655 3656 3657 3658 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3655 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.
3681 3682 3683 3684 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3681 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.
3703 3704 3705 3706 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3703 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.
3727 3728 3729 3730 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3727 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.
3756 3757 3758 3759 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3756 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.
3815 3816 3817 3818 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3815 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.
3872 3873 3874 3875 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3872 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 |
3982 3983 3984 3985 3986 |
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/client.rb', line 3982 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |