class Aws::Macie::Client
An API client for Macie
. To construct a client, you need to configure a `:region` and `:credentials`.
client = Aws::Macie::Client.new( region: region_name, credentials: credentials, # ... )
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-macie/client.rb, line 665 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures. When `:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-macie/client.rb, line 334 def initialize(*args) super end
Public Instance Methods
Associates a specified AWS account with Amazon Macie
Classic as a member account.
@option params [required, String] :member_account_id
The ID of the AWS account that you want to associate with Amazon Macie Classic as a member account.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.associate_member_account({ member_account_id: "AWSAccountId", # required })
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/AssociateMemberAccount AWS API Documentation
@overload associate_member_account
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 359 def associate_member_account(params = {}, options = {}) req = build_request(:associate_member_account, params) req.send_request(options) end
Associates specified S3 resources with Amazon Macie
Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie
Classic for the current Macie
Classic administrator account. If memberAccountId is specified, the action associates specified S3 resources with Macie
Classic for the specified member account.
@option params [String] :member_account_id
The ID of the Amazon Macie Classic member account whose resources you want to associate with Macie Classic.
@option params [required, Array<Types::S3ResourceClassification>] :s3_resources
The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification.
@return [Types::AssociateS3ResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::AssociateS3ResourcesResult#failed_s3_resources #failed_s3_resources} => Array<Types::FailedS3Resource>
@example Request syntax with placeholder values
resp = client.associate_s3_resources({ member_account_id: "AWSAccountId", s3_resources: [ # required { bucket_name: "BucketName", # required prefix: "Prefix", classification_type: { # required one_time: "FULL", # required, accepts FULL, NONE continuous: "FULL", # required, accepts FULL }, }, ], })
@example Response structure
resp.failed_s3_resources #=> Array resp.failed_s3_resources[0].failed_item.bucket_name #=> String resp.failed_s3_resources[0].failed_item.prefix #=> String resp.failed_s3_resources[0].error_code #=> String resp.failed_s3_resources[0].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/AssociateS3Resources AWS API Documentation
@overload associate_s3_resources
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 411 def associate_s3_resources(params = {}, options = {}) req = build_request(:associate_s3_resources, params) req.send_request(options) end
@param params ({}) @api private
# File lib/aws-sdk-macie/client.rb, line 640 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-macie' context[:gem_version] = '1.31.0' Seahorse::Client::Request.new(handlers, context) end
Removes the specified member account from Amazon Macie
Classic.
@option params [required, String] :member_account_id
The ID of the member account that you want to remove from Amazon Macie Classic.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_member_account({ member_account_id: "AWSAccountId", # required })
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/DisassociateMemberAccount AWS API Documentation
@overload disassociate_member_account
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 434 def disassociate_member_account(params = {}, options = {}) req = build_request(:disassociate_member_account, params) req.send_request(options) end
Removes specified S3 resources from being monitored by Amazon Macie
Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie
Classic for the current Macie
Classic administrator account. If memberAccountId is specified, the action removes specified S3 resources from Macie
Classic for the specified member account.
@option params [String] :member_account_id
The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Macie Classic.
@option params [required, Array<Types::S3Resource>] :associated_s3_resources
The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie Classic.
@return [Types::DisassociateS3ResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DisassociateS3ResourcesResult#failed_s3_resources #failed_s3_resources} => Array<Types::FailedS3Resource>
@example Request syntax with placeholder values
resp = client.disassociate_s3_resources({ member_account_id: "AWSAccountId", associated_s3_resources: [ # required { bucket_name: "BucketName", # required prefix: "Prefix", }, ], })
@example Response structure
resp.failed_s3_resources #=> Array resp.failed_s3_resources[0].failed_item.bucket_name #=> String resp.failed_s3_resources[0].failed_item.prefix #=> String resp.failed_s3_resources[0].error_code #=> String resp.failed_s3_resources[0].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/DisassociateS3Resources AWS API Documentation
@overload disassociate_s3_resources
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 482 def disassociate_s3_resources(params = {}, options = {}) req = build_request(:disassociate_s3_resources, params) req.send_request(options) end
Lists all Amazon Macie
Classic member accounts for the current Macie
Classic administrator account.
@option params [String] :next_token
Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
@option params [Integer] :max_results
Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
@return [Types::ListMemberAccountsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListMemberAccountsResult#member_accounts #member_accounts} => Array<Types::MemberAccount> * {Types::ListMemberAccountsResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_member_accounts({ next_token: "NextToken", max_results: 1, })
@example Response structure
resp.member_accounts #=> Array resp.member_accounts[0].account_id #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/ListMemberAccounts AWS API Documentation
@overload list_member_accounts
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 525 def list_member_accounts(params = {}, options = {}) req = build_request(:list_member_accounts, params) req.send_request(options) end
Lists all the S3 resources associated with Amazon Macie
Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Macie
Classic for the current Macie
Classic administrator account. If memberAccountId is specified, the action lists the S3 resources associated with Macie
Classic for the specified member account.
@option params [String] :member_account_id
The Amazon Macie Classic member account ID whose associated S3 resources you want to list.
@option params [String] :next_token
Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
@option params [Integer] :max_results
Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
@return [Types::ListS3ResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListS3ResourcesResult#s3_resources #s3_resources} => Array<Types::S3ResourceClassification> * {Types::ListS3ResourcesResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_s3_resources({ member_account_id: "AWSAccountId", next_token: "NextToken", max_results: 1, })
@example Response structure
resp.s3_resources #=> Array resp.s3_resources[0].bucket_name #=> String resp.s3_resources[0].prefix #=> String resp.s3_resources[0].classification_type.one_time #=> String, one of "FULL", "NONE" resp.s3_resources[0].classification_type.continuous #=> String, one of "FULL" resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/ListS3Resources AWS API Documentation
@overload list_s3_resources
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 579 def list_s3_resources(params = {}, options = {}) req = build_request(:list_s3_resources, params) req.send_request(options) end
Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie
Classic for the current Macie
Classic administrator account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Macie
Classic for the specified member account.
@option params [String] :member_account_id
The AWS ID of the Amazon Macie Classic member account whose S3 resources' classification types you want to update.
@option params [required, Array<Types::S3ResourceClassificationUpdate>] :s3_resources_update
The S3 resources whose classification types you want to update.
@return [Types::UpdateS3ResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateS3ResourcesResult#failed_s3_resources #failed_s3_resources} => Array<Types::FailedS3Resource>
@example Request syntax with placeholder values
resp = client.update_s3_resources({ member_account_id: "AWSAccountId", s3_resources_update: [ # required { bucket_name: "BucketName", # required prefix: "Prefix", classification_type_update: { # required one_time: "FULL", # accepts FULL, NONE continuous: "FULL", # accepts FULL }, }, ], })
@example Response structure
resp.failed_s3_resources #=> Array resp.failed_s3_resources[0].failed_item.bucket_name #=> String resp.failed_s3_resources[0].failed_item.prefix #=> String resp.failed_s3_resources[0].error_code #=> String resp.failed_s3_resources[0].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/UpdateS3Resources AWS API Documentation
@overload update_s3_resources
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-macie/client.rb, line 631 def update_s3_resources(params = {}, options = {}) req = build_request(:update_s3_resources, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-macie/client.rb, line 655 def waiter_names [] end