You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AccessAnalyzer::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Access Analyzer. To construct a client, you need to configure a :region and :credentials.

accessanalyzer = Aws::AccessAnalyzer::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::AccessAnalyzer::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::AccessAnalyzer::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#apply_archive_rule(options = {}) ⇒ Struct

Retroactively applies the archive rule to existing findings that meet the archive rule criteria.

Examples:

Request syntax with placeholder values


resp = client.apply_archive_rule({
  analyzer_arn: "AnalyzerArn", # required
  client_token: "String",
  rule_name: "Name", # required
})

Options Hash (options):

  • :analyzer_arn (required, String) —

    The Amazon resource name (ARN) of the analyzer.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :rule_name (required, String) —

    The name of the rule to apply.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#create_analyzer(options = {}) ⇒ Types::CreateAnalyzerResponse

Creates an analyzer for your account.

Examples:

Request syntax with placeholder values


resp = client.create_analyzer({
  analyzer_name: "Name", # required
  archive_rules: [
    {
      filter: { # required
        "String" => {
          contains: ["String"],
          eq: ["String"],
          exists: false,
          neq: ["String"],
        },
      },
      rule_name: "Name", # required
    },
  ],
  client_token: "String",
  tags: {
    "String" => "String",
  },
  type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION
})

Response structure


resp.arn #=> String

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer to create.

  • :archive_rules (Array<Types::InlineArchiveRule>) —

    Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :tags (Hash<String,String>) —

    The tags to apply to the analyzer.

  • :type (required, String) —

    The type of analyzer to create. Only ACCOUNT analyzers are supported. You can create only one analyzer per account per Region.

Returns:

See Also:

#create_archive_rule(options = {}) ⇒ Struct

Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

Examples:

Request syntax with placeholder values


resp = client.create_archive_rule({
  analyzer_name: "Name", # required
  client_token: "String",
  filter: { # required
    "String" => {
      contains: ["String"],
      eq: ["String"],
      exists: false,
      neq: ["String"],
    },
  },
  rule_name: "Name", # required
})

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the created analyzer.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :filter (required, Hash<String,Types::Criterion>) —

    The criteria for the rule.

  • :rule_name (required, String) —

    The name of the rule to create.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_analyzer(options = {}) ⇒ Struct

Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the account in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.

Examples:

Request syntax with placeholder values


resp = client.delete_analyzer({
  analyzer_name: "Name", # required
  client_token: "String",
})

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer to delete.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_archive_rule(options = {}) ⇒ Struct

Deletes the specified archive rule.

Examples:

Request syntax with placeholder values


resp = client.delete_archive_rule({
  analyzer_name: "Name", # required
  client_token: "String",
  rule_name: "Name", # required
})

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer that associated with the archive rule to delete.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :rule_name (required, String) —

    The name of the rule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#get_analyzed_resource(options = {}) ⇒ Types::GetAnalyzedResourceResponse

Retrieves information about a resource that was analyzed.

Examples:

Request syntax with placeholder values


resp = client.get_analyzed_resource({
  analyzer_arn: "AnalyzerArn", # required
  resource_arn: "ResourceArn", # required
})

Response structure


resp.resource.actions #=> Array
resp.resource.actions[0] #=> String
resp.resource.analyzed_at #=> Time
resp.resource.created_at #=> Time
resp.resource.error #=> String
resp.resource.is_public #=> true/false
resp.resource.resource_arn #=> String
resp.resource. #=> String
resp.resource.resource_type #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key"
resp.resource.shared_via #=> Array
resp.resource.shared_via[0] #=> String
resp.resource.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.resource.updated_at #=> Time

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer to retrieve information from.

  • :resource_arn (required, String) —

    The ARN of the resource to retrieve information about.

Returns:

See Also:

#get_analyzer(options = {}) ⇒ Types::GetAnalyzerResponse

Retrieves information about the specified analyzer.

Examples:

Request syntax with placeholder values


resp = client.get_analyzer({
  analyzer_name: "Name", # required
})

Response structure


resp.analyzer.arn #=> String
resp.analyzer.created_at #=> Time
resp.analyzer.last_resource_analyzed #=> String
resp.analyzer.last_resource_analyzed_at #=> Time
resp.analyzer.name #=> String
resp.analyzer.status #=> String, one of "ACTIVE", "CREATING", "DISABLED", "FAILED"
resp.analyzer.status_reason.code #=> String, one of "AWS_SERVICE_ACCESS_DISABLED", "DELEGATED_ADMINISTRATOR_DEREGISTERED", "ORGANIZATION_DELETED", "SERVICE_LINKED_ROLE_CREATION_FAILED"
resp.analyzer.tags #=> Hash
resp.analyzer.tags["String"] #=> String
resp.analyzer.type #=> String, one of "ACCOUNT", "ORGANIZATION"

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer retrieved.

Returns:

See Also:

#get_archive_rule(options = {}) ⇒ Types::GetArchiveRuleResponse

Retrieves information about an archive rule.

To learn about filter keys that you can use to create an archive rule, see Access Analyzer filter keys in the IAM User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_archive_rule({
  analyzer_name: "Name", # required
  rule_name: "Name", # required
})

Response structure


resp.archive_rule.created_at #=> Time
resp.archive_rule.filter #=> Hash
resp.archive_rule.filter["String"].contains #=> Array
resp.archive_rule.filter["String"].contains[0] #=> String
resp.archive_rule.filter["String"].eq #=> Array
resp.archive_rule.filter["String"].eq[0] #=> String
resp.archive_rule.filter["String"].exists #=> true/false
resp.archive_rule.filter["String"].neq #=> Array
resp.archive_rule.filter["String"].neq[0] #=> String
resp.archive_rule.rule_name #=> String
resp.archive_rule.updated_at #=> Time

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer to retrieve rules from.

  • :rule_name (required, String) —

    The name of the rule to retrieve.

Returns:

See Also:

#get_finding(options = {}) ⇒ Types::GetFindingResponse

Retrieves information about the specified finding.

Examples:

Request syntax with placeholder values


resp = client.get_finding({
  analyzer_arn: "AnalyzerArn", # required
  id: "FindingId", # required
})

Response structure


resp.finding.action #=> Array
resp.finding.action[0] #=> String
resp.finding.analyzed_at #=> Time
resp.finding.condition #=> Hash
resp.finding.condition["String"] #=> String
resp.finding.created_at #=> Time
resp.finding.error #=> String
resp.finding.id #=> String
resp.finding.is_public #=> true/false
resp.finding.principal #=> Hash
resp.finding.principal["String"] #=> String
resp.finding.resource #=> String
resp.finding. #=> String
resp.finding.resource_type #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key"
resp.finding.sources #=> Array
resp.finding.sources[0].detail.access_point_arn #=> String
resp.finding.sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT"
resp.finding.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.finding.updated_at #=> Time

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer that generated the finding.

  • :id (required, String) —

    The ID of the finding to retrieve.

Returns:

See Also:

#list_analyzed_resources(options = {}) ⇒ Types::ListAnalyzedResourcesResponse

Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..

Examples:

Request syntax with placeholder values


resp = client.list_analyzed_resources({
  analyzer_arn: "AnalyzerArn", # required
  max_results: 1,
  next_token: "Token",
  resource_type: "AWS::S3::Bucket", # accepts AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key
})

Response structure


resp.analyzed_resources #=> Array
resp.analyzed_resources[0].resource_arn #=> String
resp.analyzed_resources[0]. #=> String
resp.analyzed_resources[0].resource_type #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key"
resp.next_token #=> String

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer to retrieve a list of analyzed resources from.

  • :max_results (Integer) —

    The maximum number of results to return in the response.

  • :next_token (String) —

    A token used for pagination of results returned.

  • :resource_type (String) —

    The type of resource.

Returns:

See Also:

#list_analyzers(options = {}) ⇒ Types::ListAnalyzersResponse

Retrieves a list of analyzers.

Examples:

Request syntax with placeholder values


resp = client.list_analyzers({
  max_results: 1,
  next_token: "Token",
  type: "ACCOUNT", # accepts ACCOUNT, ORGANIZATION
})

Response structure


resp.analyzers #=> Array
resp.analyzers[0].arn #=> String
resp.analyzers[0].created_at #=> Time
resp.analyzers[0].last_resource_analyzed #=> String
resp.analyzers[0].last_resource_analyzed_at #=> Time
resp.analyzers[0].name #=> String
resp.analyzers[0].status #=> String, one of "ACTIVE", "CREATING", "DISABLED", "FAILED"
resp.analyzers[0].status_reason.code #=> String, one of "AWS_SERVICE_ACCESS_DISABLED", "DELEGATED_ADMINISTRATOR_DEREGISTERED", "ORGANIZATION_DELETED", "SERVICE_LINKED_ROLE_CREATION_FAILED"
resp.analyzers[0].tags #=> Hash
resp.analyzers[0].tags["String"] #=> String
resp.analyzers[0].type #=> String, one of "ACCOUNT", "ORGANIZATION"
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer) —

    The maximum number of results to return in the response.

  • :next_token (String) —

    A token used for pagination of results returned.

  • :type (String) —

    The type of analyzer.

Returns:

See Also:

#list_archive_rules(options = {}) ⇒ Types::ListArchiveRulesResponse

Retrieves a list of archive rules created for the specified analyzer.

Examples:

Request syntax with placeholder values


resp = client.list_archive_rules({
  analyzer_name: "Name", # required
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.archive_rules #=> Array
resp.archive_rules[0].created_at #=> Time
resp.archive_rules[0].filter #=> Hash
resp.archive_rules[0].filter["String"].contains #=> Array
resp.archive_rules[0].filter["String"].contains[0] #=> String
resp.archive_rules[0].filter["String"].eq #=> Array
resp.archive_rules[0].filter["String"].eq[0] #=> String
resp.archive_rules[0].filter["String"].exists #=> true/false
resp.archive_rules[0].filter["String"].neq #=> Array
resp.archive_rules[0].filter["String"].neq[0] #=> String
resp.archive_rules[0].rule_name #=> String
resp.archive_rules[0].updated_at #=> Time
resp.next_token #=> String

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer to retrieve rules from.

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    A token used for pagination of results returned.

Returns:

See Also:

#list_findings(options = {}) ⇒ Types::ListFindingsResponse

Retrieves a list of findings generated by the specified analyzer.

To learn about filter keys that you can use to create an archive rule, see Access Analyzer filter keys in the IAM User Guide.

Examples:

Request syntax with placeholder values


resp = client.list_findings({
  analyzer_arn: "AnalyzerArn", # required
  filter: {
    "String" => {
      contains: ["String"],
      eq: ["String"],
      exists: false,
      neq: ["String"],
    },
  },
  max_results: 1,
  next_token: "Token",
  sort: {
    attribute_name: "String",
    order_by: "ASC", # accepts ASC, DESC
  },
})

Response structure


resp.findings #=> Array
resp.findings[0].action #=> Array
resp.findings[0].action[0] #=> String
resp.findings[0].analyzed_at #=> Time
resp.findings[0].condition #=> Hash
resp.findings[0].condition["String"] #=> String
resp.findings[0].created_at #=> Time
resp.findings[0].error #=> String
resp.findings[0].id #=> String
resp.findings[0].is_public #=> true/false
resp.findings[0].principal #=> Hash
resp.findings[0].principal["String"] #=> String
resp.findings[0].resource #=> String
resp.findings[0]. #=> String
resp.findings[0].resource_type #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key"
resp.findings[0].sources #=> Array
resp.findings[0].sources[0].detail.access_point_arn #=> String
resp.findings[0].sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT"
resp.findings[0].status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0].updated_at #=> Time
resp.next_token #=> String

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer to retrieve findings from.

  • :filter (Hash<String,Types::Criterion>) —

    A filter to match for the findings to return.

  • :max_results (Integer) —

    The maximum number of results to return in the response.

  • :next_token (String) —

    A token used for pagination of results returned.

  • :sort (Types::SortCriteria) —

    The sort order for the findings returned.

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves a list of tags applied to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the resource to retrieve tags from.

Returns:

See Also:

#start_resource_scan(options = {}) ⇒ Struct

Immediately starts a scan of the policies applied to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.start_resource_scan({
  analyzer_arn: "AnalyzerArn", # required
  resource_arn: "ResourceArn", # required
})

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer to use to scan the policies applied to the specified resource.

  • :resource_arn (required, String) —

    The ARN of the resource to scan.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds a tag to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the resource to add the tag to.

  • :tags (required, Hash<String,String>) —

    The tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes a tag from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the resource to remove the tag from.

  • :tag_keys (required, Array<String>) —

    The key for the tag to add.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update_archive_rule(options = {}) ⇒ Struct

Updates the criteria and values for the specified archive rule.

Examples:

Request syntax with placeholder values


resp = client.update_archive_rule({
  analyzer_name: "Name", # required
  client_token: "String",
  filter: { # required
    "String" => {
      contains: ["String"],
      eq: ["String"],
      exists: false,
      neq: ["String"],
    },
  },
  rule_name: "Name", # required
})

Options Hash (options):

  • :analyzer_name (required, String) —

    The name of the analyzer to update the archive rules for.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :filter (required, Hash<String,Types::Criterion>) —

    A filter to match for the rules to update. Only rules that match the filter are updated.

  • :rule_name (required, String) —

    The name of the rule to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update_findings(options = {}) ⇒ Struct

Updates the status for the specified findings.

Examples:

Request syntax with placeholder values


resp = client.update_findings({
  analyzer_arn: "AnalyzerArn", # required
  client_token: "String",
  ids: ["FindingId"],
  resource_arn: "ResourceArn",
  status: "ACTIVE", # required, accepts ACTIVE, ARCHIVED
})

Options Hash (options):

  • :analyzer_arn (required, String) —

    The ARN of the analyzer that generated the findings to update.

  • :client_token (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A client token.

  • :ids (Array<String>) —

    The IDs of the findings to update.

  • :resource_arn (String) —

    The ARN of the resource identified in the finding.

  • :status (required, String) —

    The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

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(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.