Class: Aws::AccessAnalyzer::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb

Overview

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

client = Aws::AccessAnalyzer::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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test 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.

  • :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.

  • :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 https://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.

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

  • :validate_params (Boolean) — default: true —

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

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://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 (Integer) — 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.

  • :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.



305
306
307
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 305

def initialize(*args)
  super
end

Instance Method Details

#create_analyzer(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



370
371
372
373
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 370

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

#create_archive_rule(params = {}) ⇒ Struct

Creates an archive rule for the specified analyzer. Archive rules automatically archive 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_name (required, String) —

    The name of the created analyzer.

  • :client_token (String) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



416
417
418
419
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 416

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

#delete_analyzer(params = {}) ⇒ 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",
})

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_name (required, String) —

    The name of the analyzer to delete.

  • :client_token (String) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



448
449
450
451
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 448

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

#delete_archive_rule(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_name (required, String) —

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

  • :client_token (String) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :rule_name (required, String) —

    The name of the rule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



482
483
484
485
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 482

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

#get_analyzed_resource(params = {}) ⇒ 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 #=> Boolean
resp.resource.resource_arn #=> String
resp.resource. #=> String
resp.resource.resource_type #=> String, one of "AWS::IAM::Role", "AWS::KMS::Key", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::S3::Bucket", "AWS::SQS::Queue"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



526
527
528
529
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 526

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

#get_analyzer(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_name (required, String) —

    The name of the analyzer retrieved.

Returns:

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 563

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

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

Retrieves information about an archive rule.

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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



605
606
607
608
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 605

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

#get_finding(params = {}) ⇒ 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 #=> Boolean
resp.finding.principal #=> Hash
resp.finding.principal["String"] #=> String
resp.finding.resource #=> String
resp.finding. #=> String
resp.finding.resource_type #=> String, one of "AWS::IAM::Role", "AWS::KMS::Key", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::S3::Bucket", "AWS::SQS::Queue"
resp.finding.sources #=> Array
resp.finding.sources[0].detail.access_point_arn #=> String
resp.finding.sources[0].type #=> String, one of "BUCKET_ACL", "POLICY", "S3_ACCESS_POINT"
resp.finding.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.finding.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :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:



655
656
657
658
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 655

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

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

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

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_analyzed_resources({
  analyzer_arn: "AnalyzerArn", # required
  max_results: 1,
  next_token: "Token",
  resource_type: "AWS::IAM::Role", # accepts AWS::IAM::Role, AWS::KMS::Key, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::S3::Bucket, AWS::SQS::Queue
})

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::IAM::Role", "AWS::KMS::Key", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::S3::Bucket", "AWS::SQS::Queue"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



703
704
705
706
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 703

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

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

Retrieves a list of analyzers.

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_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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



753
754
755
756
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 753

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

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

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

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_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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



804
805
806
807
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 804

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

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

Retrieves a list of findings generated by the specified analyzer.

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_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 #=> Boolean
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::IAM::Role", "AWS::KMS::Key", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::S3::Bucket", "AWS::SQS::Queue"
resp.findings[0].sources #=> Array
resp.findings[0].sources[0].detail.access_point_arn #=> String
resp.findings[0].sources[0].type #=> String, one of "BUCKET_ACL", "POLICY", "S3_ACCESS_POINT"
resp.findings[0].status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



881
882
883
884
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 881

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

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to retrieve tags from.

Returns:

See Also:



910
911
912
913
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 910

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

#start_resource_scan(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



938
939
940
941
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 938

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

#tag_resource(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



966
967
968
969
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 966

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

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



992
993
994
995
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 992

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

#update_archive_rule(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_name (required, String) —

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

  • :client_token (String) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



1037
1038
1039
1040
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 1037

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

#update_findings(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :analyzer_arn (required, String) —

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

  • :client_token (String) —

    A client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



1080
1081
1082
1083
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb', line 1080

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