Class: Aws::Macie::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-macie/client.rb

Overview

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.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    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`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.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. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String)

    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:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :client_side_monitoring (Boolean) — default: false

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String)

    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.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :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 www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "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.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: 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.

  • :stub_responses (Boolean) — default: 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.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Macie::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Macie::EndpointParameters`

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 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.

  • :http_continue_timeout (Float) — default: 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.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    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.

  • :ssl_ca_directory (String)

    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.



395
396
397
# File 'lib/aws-sdk-macie/client.rb', line 395

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



727
728
729
# File 'lib/aws-sdk-macie/client.rb', line 727

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



730
731
732
# File 'lib/aws-sdk-macie/client.rb', line 730

def errors_module
  Errors
end

Instance Method Details

#associate_member_account(params = {}) ⇒ Struct

(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member account.

Examples:

Request syntax with placeholder values


resp = client.({
  member_account_id: "AWSAccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (required, String) — default: Discontinued

    The ID of the Amazon Web Services account that you want to associate with Amazon Macie Classic as a member account.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



420
421
422
423
# File 'lib/aws-sdk-macie/client.rb', line 420

def (params = {}, options = {})
  req = build_request(:associate_member_account, params)
  req.send_request(options)
end

#associate_s3_resources(params = {}) ⇒ Types::AssociateS3ResourcesResult

(Discontinued) 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.

Examples:

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
      },
    },
  ],
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (String) — default: Discontinued

    The ID of the Amazon Macie Classic member account whose resources you want to associate with Macie Classic.

  • :s3_resources (required, Array<Types::S3ResourceClassification>) — default: Discontinued

    The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification.

Returns:

See Also:



472
473
474
475
# File 'lib/aws-sdk-macie/client.rb', line 472

def associate_s3_resources(params = {}, options = {})
  req = build_request(:associate_s3_resources, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {})


705
706
707
708
709
710
711
712
713
714
715
716
# File 'lib/aws-sdk-macie/client.rb', line 705

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.48.0'
  Seahorse::Client::Request.new(handlers, context)
end

#disassociate_member_account(params = {}) ⇒ Struct

(Discontinued) Removes the specified member account from Amazon Macie Classic.

Examples:

Request syntax with placeholder values


resp = client.({
  member_account_id: "AWSAccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (required, String) — default: Discontinued

    The ID of the member account that you want to remove from Amazon Macie Classic.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



496
497
498
499
# File 'lib/aws-sdk-macie/client.rb', line 496

def (params = {}, options = {})
  req = build_request(:disassociate_member_account, params)
  req.send_request(options)
end

#disassociate_s3_resources(params = {}) ⇒ Types::DisassociateS3ResourcesResult

(Discontinued) 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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_s3_resources({
  member_account_id: "AWSAccountId",
  associated_s3_resources: [ # required
    {
      bucket_name: "BucketName", # required
      prefix: "Prefix",
    },
  ],
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (String) — default: Discontinued

    The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Macie Classic.

  • :associated_s3_resources (required, Array<Types::S3Resource>) — default: Discontinued

    The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie Classic.

Returns:

See Also:



544
545
546
547
# File 'lib/aws-sdk-macie/client.rb', line 544

def disassociate_s3_resources(params = {}, options = {})
  req = build_request(:disassociate_s3_resources, params)
  req.send_request(options)
end

#list_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResult

(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_member_accounts({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.member_accounts #=> Array
resp.member_accounts[0]. #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String) — default: Discontinued

    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.

  • :max_results (Integer) — default: Discontinued

    Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

Returns:

See Also:



587
588
589
590
# File 'lib/aws-sdk-macie/client.rb', line 587

def list_member_accounts(params = {}, options = {})
  req = build_request(:list_member_accounts, params)
  req.send_request(options)
end

#list_s3_resources(params = {}) ⇒ Types::ListS3ResourcesResult

(Discontinued) 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_s3_resources({
  member_account_id: "AWSAccountId",
  next_token: "NextToken",
  max_results: 1,
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (String) — default: Discontinued

    The Amazon Macie Classic member account ID whose associated S3 resources you want to list.

  • :next_token (String) — default: Discontinued

    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.

  • :max_results (Integer) — default: Discontinued

    Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

Returns:

See Also:



642
643
644
645
# File 'lib/aws-sdk-macie/client.rb', line 642

def list_s3_resources(params = {}, options = {})
  req = build_request(:list_s3_resources, params)
  req.send_request(options)
end

#update_s3_resources(params = {}) ⇒ Types::UpdateS3ResourcesResult

(Discontinued) 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.

Examples:

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
      },
    },
  ],
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_account_id (String) — default: Discontinued

    The Amazon Web Services account ID of the Amazon Macie Classic member account whose S3 resources’ classification types you want to update.

  • :s3_resources_update (required, Array<Types::S3ResourceClassificationUpdate>) — default: Discontinued

    The S3 resources whose classification types you want to update.

Returns:

See Also:



696
697
698
699
# File 'lib/aws-sdk-macie/client.rb', line 696

def update_s3_resources(params = {}, options = {})
  req = build_request(:update_s3_resources, params)
  req.send_request(options)
end

#waiter_namesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.


720
721
722
# File 'lib/aws-sdk-macie/client.rb', line 720

def waiter_names
  []
end