Class: Aws::AccessAnalyzer::Client

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

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.

Defined Under Namespace

Modules: _CancelPolicyGenerationResponseSuccess, _CheckAccessNotGrantedResponseSuccess, _CheckNoNewAccessResponseSuccess, _CheckNoPublicAccessResponseSuccess, _CreateAccessPreviewResponseSuccess, _CreateAnalyzerResponseSuccess, _CreateServiceLinkedAnalyzerResponseSuccess, _GetAccessPreviewResponseSuccess, _GetAnalyzedResourceResponseSuccess, _GetAnalyzerResponseSuccess, _GetArchiveRuleResponseSuccess, _GetFindingRecommendationResponseSuccess, _GetFindingResponseSuccess, _GetFindingV2ResponseSuccess, _GetFindingsStatisticsResponseSuccess, _GetGeneratedPolicyResponseSuccess, _ListAccessPreviewFindingsResponseSuccess, _ListAccessPreviewsResponseSuccess, _ListAnalyzedResourcesResponseSuccess, _ListAnalyzersResponseSuccess, _ListArchiveRulesResponseSuccess, _ListFindingsResponseSuccess, _ListFindingsV2ResponseSuccess, _ListPolicyGenerationsResponseSuccess, _ListTagsForResourceResponseSuccess, _StartPolicyGenerationResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateAnalyzerResponseSuccess, _ValidatePolicyResponseSuccess

Constant Summary collapse

Params =

Returns:


      
    

  




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

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or 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, :session_token, and
:account_id options.
      

      • 

    • 

      ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
      

      • 

    • 

      ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to
enable retries and extended timeouts. Instance profile credential fetching can be disabled by
setting ENV['AWS_EC2_METADATA_DISABLED'] 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:
    

      

    • Aws.config[:region]
      • 

    • ENV['AWS_REGION']
      • 

    • ENV['AMAZON_REGION']
      • 

    • ENV['AWS_DEFAULT_REGION']
      • 

    • ~/.aws/credentials
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :access_key_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :account_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.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :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
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'

    
          
        
    • 
      
        
  • 
          :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_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

    • when_supported - (default) When set, a checksum will be
calculated for all request payloads of operations modeled with the
httpChecksum trait where requestChecksumRequired is true and/or a
requestAlgorithmMember is modeled.
      • 

    • when_required - When set, a checksum will only be calculated for
request payloads of operations modeled with the  httpChecksum trait where
requestChecksumRequired is true or where a requestAlgorithmMember
is modeled and supplied.
      • 

    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

    • when_supported - (default) When set, checksum validation is performed on all
response payloads of operations modeled with the httpChecksum trait where
responseAlgorithms is modeled, except when no modeled checksum algorithms
are supported.
      • 

    • when_required - When set, checksum validation is not performed on
response payloads of operations unless the checksum algorithm is supported and
the requestValidationModeMember member is set to ENABLED.
      • 

    
          
        
    • 
      
        
  • 
          :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 the 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 - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :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. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk gem and then, pass in an instance of a
Aws::Telemetry::OTelProvider for telemetry provider.
      • 

    
          
        
    • 
      
        
  • 
          :token_provider
          (Aws::TokenProvider)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or 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::AccessAnalyzer::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::AccessAnalyzer::EndpointParameters.
    
          
        
    • 
      
        
  • 
          :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_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_open_timeout
          (Float)
          
            
              — default:
              15
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_proxy
          (URI::HTTP, String)
          
            
          
          
            — 
    A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :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_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true,  HTTP debug output will be sent to the :logger.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


471
472
473

    		
    
      
# File 'lib/aws-sdk-accessanalyzer/client.rb', line 471

def initialize(*args)
  super
end


    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (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.




  





  

API:


    
  
    
  • 
      
      
      
      
        
        
    private
    
      
    
    • 
  





  

    
      


3082
3083
3084

    		
    
      
# File 'lib/aws-sdk-accessanalyzer/client.rb', line 3082

def identifier
  @identifier
end


    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ 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.




  





  

API:


    
  
    
  • 
      
      
      
      
        
        
    private
    
      
    
    • 
  





  

    
      


3085
3086
3087

    		
    
      
# File 'lib/aws-sdk-accessanalyzer/client.rb', line 3085

def errors_module
  Errors
end


    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AccessAnalyzer/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (


    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #apply_archive_rule(params = {})  ⇒ 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
  rule_name: "Name", # required
  client_token: "String",
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The Amazon resource name (ARN) of the analyzer.
    
          
        
    • 
      
        
  • 
          :rule_name
          (required, String)
          
            
          
          
            — 
    The name of the rule to apply.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


82

    		
    
      
# File 'sig/client.rbs', line 82

def apply_archive_rule: (


    		
  





    
      

  

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


    
  
    
  • 
      
      
      
        (defaults to: {})
      
      
    
    • 
  




API:


    
  
    
  • 
      
      
      
      
        
        
    private
    
      
    
    • 
  





  

    
      


3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071

    		
    
      
# File 'lib/aws-sdk-accessanalyzer/client.rb', line 3055

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::AccessAnalyzer')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-accessanalyzer'
  context[:gem_version] = '1.96.0'
  Seahorse::Client::Request.new(handlers, context)
end


    		
  





    
      

  

  
    #cancel_policy_generation(params = {})  ⇒ Struct 
  

  

  




  

    
Cancels the requested policy generation.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.cancel_policy_generation({
  job_id: "JobId", # required
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :job_id
          (required, String)
          
            
          
          
            — 
    The JobId that is returned by the StartPolicyGeneration operation.
The JobId can be used with GetGeneratedPolicy to retrieve the
generated policies or used with CancelPolicyGeneration to cancel the
policy generation request.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


93

    		
    
      
# File 'sig/client.rbs', line 93

def cancel_policy_generation: (


    		
  





    
      

  

  
    #check_access_not_granted(params = {})  ⇒ Types::CheckAccessNotGrantedResponse 
  

  

  




  

    
Checks whether the specified access isn't allowed by a policy.


  





  
  

    
Examples:

    
      
        
Example: Passing check. Restrictive identity policy.

      
      

resp = client.check_access_not_granted({
  access: [
    {
      actions: [
        "s3:PutObject", 
      ], 
    }, 
  ], 
  policy_document: "{\"Version\":\"2012-10-17\",\"Id\":\"123\",\"Statement\":[{\"Sid\":\"AllowJohnDoe\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:user/JohnDoe\"},\"Action\":\"s3:GetObject\",\"Resource\":\"*\"}]}", 
  policy_type: "RESOURCE_POLICY", 
})

resp.to_h outputs the following:
{
  message: "The policy document does not grant access to perform the listed actions or resources.", 
  result: "PASS", 
}


    
      
        
Example: Passing check. Restrictive S3 Bucket resource policy.

      
      

resp = client.check_access_not_granted({
  access: [
    {
      resources: [
        "arn:aws:s3:::sensitive-bucket/*", 
      ], 
    }, 
  ], 
  policy_document: "{\"Version\":\"2012-10-17\",\"Id\":\"123\",\"Statement\":[{\"Sid\":\"AllowJohnDoe\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:user/JohnDoe\"},\"Action\":\"s3:PutObject\",\"Resource\":\"arn:aws:s3:::non-sensitive-bucket/*\"}]}", 
  policy_type: "RESOURCE_POLICY", 
})

resp.to_h outputs the following:
{
  message: "The policy document does not grant access to perform the listed actions or resources.", 
  result: "PASS", 
}


    
      
        
Example: Failing check. Permissive S3 Bucket resource policy.

      
      

resp = client.check_access_not_granted({
  access: [
    {
      resources: [
        "arn:aws:s3:::my-bucket/*", 
      ], 
    }, 
  ], 
  policy_document: "{\"Version\":\"2012-10-17\",\"Id\":\"123\",\"Statement\":[{\"Sid\":\"AllowJohnDoe\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:user/JohnDoe\"},\"Action\":\"s3:PutObject\",\"Resource\":\"arn:aws:s3:::my-bucket/*\"}]}", 
  policy_type: "RESOURCE_POLICY", 
})

resp.to_h outputs the following:
{
  message: "The policy document grants access to perform one or more of the listed actions or resources.", 
  reasons: [
    {
      description: "One or more of the listed actions or resources in the statement with sid: AllowJohnDoe.", 
      statement_id: "AllowJohnDoe", 
      statement_index: 0, 
    }, 
  ], 
  result: "FAIL", 
}


    
      
        
Request syntax with placeholder values

      
      

resp = client.check_access_not_granted({
  policy_document: "AccessCheckPolicyDocument", # required
  access: [ # required
    {
      actions: ["Action"],
      resources: ["Resource"],
    },
  ],
  policy_type: "IDENTITY_POLICY", # required, accepts IDENTITY_POLICY, RESOURCE_POLICY
})


    
      
        
Response structure

      
      

resp.result #=> String, one of "PASS", "FAIL"
resp.message #=> String
resp.reasons #=> Array
resp.reasons[0].description #=> String
resp.reasons[0].statement_index #=> Integer
resp.reasons[0].statement_id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :policy_document
          (required, String)
          
            
          
          
            — 
    The JSON policy document to use as the content for the policy.
    
          
        
    • 
      
        
  • 
          :access
          (required, Array<Types::Access>)
          
            
          
          
            — 
    An access object containing the permissions that shouldn't be granted
by the specified policy. If only actions are specified, IAM Access
Analyzer checks for access to peform at least one of the actions on
any resource in the policy. If only resources are specified, then IAM
Access Analyzer checks for access to perform any action on at least
one of the resources. If both actions and resources are specified, IAM
Access Analyzer checks for access to perform at least one of the
specified actions on at least one of the specified resources.
    
          
        
    • 
      
        
  • 
          :policy_type
          (required, String)
          
            
          
          
            — 
    The type of policy. Identity policies grant permissions to IAM
principals. Identity policies include managed and inline policies for
IAM roles, users, and groups.
    

    Resource policies grant permissions on Amazon Web Services resources.
Resource policies include trust policies for IAM roles and bucket
policies for Amazon S3 buckets.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


105

    		
    
      
# File 'sig/client.rbs', line 105

def check_access_not_granted: (


    		
  





    
      

  

  
    #check_no_new_access(params = {})  ⇒ Types::CheckNoNewAccessResponse 
  

  

  




  

    
Checks whether new access is allowed for an updated policy when
compared to the existing policy.


You can find examples for reference policies and learn how to set up
and run a custom policy check for new access in the IAM Access
Analyzer custom policy checks samples repository on GitHub. The
reference policies in this repository are meant to be passed to the
existingPolicyDocument request parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.check_no_new_access({
  new_policy_document: "AccessCheckPolicyDocument", # required
  existing_policy_document: "AccessCheckPolicyDocument", # required
  policy_type: "IDENTITY_POLICY", # required, accepts IDENTITY_POLICY, RESOURCE_POLICY
})


    
      
        
Response structure

      
      

resp.result #=> String, one of "PASS", "FAIL"
resp.message #=> String
resp.reasons #=> Array
resp.reasons[0].description #=> String
resp.reasons[0].statement_index #=> Integer
resp.reasons[0].statement_id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :new_policy_document
          (required, String)
          
            
          
          
            — 
    The JSON policy document to use as the content for the updated policy.
    
          
        
    • 
      
        
  • 
          :existing_policy_document
          (required, String)
          
            
          
          
            — 
    The JSON policy document to use as the content for the existing
policy.
    
          
        
    • 
      
        
  • 
          :policy_type
          (required, String)
          
            
          
          
            — 
    The type of policy to compare. Identity policies grant permissions to
IAM principals. Identity policies include managed and inline policies
for IAM roles, users, and groups.
    

    Resource policies grant permissions on Amazon Web Services resources.
Resource policies include trust policies for IAM roles and bucket
policies for Amazon S3 buckets. You can provide a generic input such
as identity policy or resource policy or a specific input such as
managed policy or Amazon S3 bucket policy.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


124

    		
    
      
# File 'sig/client.rbs', line 124

def check_no_new_access: (


    		
  





    
      

  

  
    #check_no_public_access(params = {})  ⇒ Types::CheckNoPublicAccessResponse 
  

  

  




  

    
Checks whether a resource policy can grant public access to the
specified resource type.


  





  
  

    
Examples:

    
      
        
Example: Passing check. S3 Bucket policy without public access.

      
      

resp = client.check_no_public_access({
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Bob\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:user/JohnDoe\"},\"Action\":[\"s3:GetObject\"]}]}", 
  resource_type: "AWS::S3::Bucket", 
})

resp.to_h outputs the following:
{
  message: "The resource policy does not grant public access for the given resource type.", 
  result: "PASS", 
}


    
      
        
Example: Failing check. S3 Bucket policy with public access.

      
      

resp = client.check_no_public_access({
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Bob\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":[\"s3:GetObject\"]}]}", 
  resource_type: "AWS::S3::Bucket", 
})

resp.to_h outputs the following:
{
  message: "The resource policy grants public access for the given resource type.", 
  reasons: [
    {
      description: "Public access granted in the following statement with sid: Bob.", 
      statement_id: "Bob", 
      statement_index: 0, 
    }, 
  ], 
  result: "FAIL", 
}


    
      
        
Request syntax with placeholder values

      
      

resp = client.check_no_public_access({
  policy_document: "AccessCheckPolicyDocument", # required
  resource_type: "AWS::DynamoDB::Table", # required, accepts AWS::DynamoDB::Table, AWS::DynamoDB::Stream, AWS::EFS::FileSystem, AWS::OpenSearchService::Domain, AWS::Kinesis::Stream, AWS::Kinesis::StreamConsumer, AWS::KMS::Key, AWS::Lambda::Function, AWS::S3::Bucket, AWS::S3::AccessPoint, AWS::S3Express::DirectoryBucket, AWS::S3::Glacier, AWS::S3Outposts::Bucket, AWS::S3Outposts::AccessPoint, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SQS::Queue, AWS::IAM::AssumeRolePolicyDocument, AWS::S3Tables::TableBucket, AWS::ApiGateway::RestApi, AWS::CodeArtifact::Domain, AWS::Backup::BackupVault, AWS::CloudTrail::Dashboard, AWS::CloudTrail::EventDataStore, AWS::S3Tables::Table, AWS::S3Express::AccessPoint
})


    
      
        
Response structure

      
      

resp.result #=> String, one of "PASS", "FAIL"
resp.message #=> String
resp.reasons #=> Array
resp.reasons[0].description #=> String
resp.reasons[0].statement_index #=> Integer
resp.reasons[0].statement_id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :policy_document
          (required, String)
          
            
          
          
            — 
    The JSON policy document to evaluate for public access.
    
          
        
    • 
      
        
  • 
          :resource_type
          (required, String)
          
            
          
          
            — 
    The type of resource to evaluate for public access. For example, to
check for public access to Amazon S3 buckets, you can choose
AWS::S3::Bucket for the resource type.
    

    For resource types not supported as valid values, IAM Access Analyzer
will return an error.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


138

    		
    
      
# File 'sig/client.rbs', line 138

def check_no_public_access: (


    		
  





    
      

  

  
    #create_access_preview(params = {})  ⇒ Types::CreateAccessPreviewResponse 
  

  

  




  

    
Creates an access preview that allows you to preview IAM Access
Analyzer findings for your resource before deploying resource
permissions.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_access_preview({
  analyzer_arn: "AnalyzerArn", # required
  configurations: { # required
    "ConfigurationsMapKey" => {
      ebs_snapshot: {
        user_ids: ["EbsUserId"],
        groups: ["EbsGroup"],
        kms_key_id: "EbsSnapshotDataEncryptionKeyId",
      },
      ecr_repository: {
        repository_policy: "EcrRepositoryPolicy",
      },
      iam_role: {
        trust_policy: "IamTrustPolicy",
      },
      efs_file_system: {
        file_system_policy: "EfsFileSystemPolicy",
      },
      kms_key: {
        key_policies: {
          "PolicyName" => "KmsKeyPolicy",
        },
        grants: [
          {
            operations: ["CreateGrant"], # required, accepts CreateGrant, Decrypt, DescribeKey, Encrypt, GenerateDataKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GenerateDataKeyWithoutPlaintext, GetPublicKey, ReEncryptFrom, ReEncryptTo, RetireGrant, Sign, Verify
            grantee_principal: "GranteePrincipal", # required
            retiring_principal: "RetiringPrincipal",
            constraints: {
              encryption_context_equals: {
                "KmsConstraintsKey" => "KmsConstraintsValue",
              },
              encryption_context_subset: {
                "KmsConstraintsKey" => "KmsConstraintsValue",
              },
            },
            issuing_account: "IssuingAccount", # required
          },
        ],
      },
      rds_db_cluster_snapshot: {
        attributes: {
          "RdsDbClusterSnapshotAttributeName" => {
            account_ids: ["RdsDbClusterSnapshotAccountId"],
          },
        },
        kms_key_id: "RdsDbClusterSnapshotKmsKeyId",
      },
      rds_db_snapshot: {
        attributes: {
          "RdsDbSnapshotAttributeName" => {
            account_ids: ["RdsDbSnapshotAccountId"],
          },
        },
        kms_key_id: "RdsDbSnapshotKmsKeyId",
      },
      secrets_manager_secret: {
        kms_key_id: "SecretsManagerSecretKmsId",
        secret_policy: "SecretsManagerSecretPolicy",
      },
      s3_bucket: {
        bucket_policy: "S3BucketPolicy",
        bucket_acl_grants: [
          {
            permission: "READ", # required, accepts READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL
            grantee: { # required
              id: "AclCanonicalId",
              uri: "AclUri",
            },
          },
        ],
        bucket_public_access_block: {
          ignore_public_acls: false, # required
          restrict_public_buckets: false, # required
        },
        access_points: {
          "AccessPointArn" => {
            access_point_policy: "AccessPointPolicy",
            public_access_block: {
              ignore_public_acls: false, # required
              restrict_public_buckets: false, # required
            },
            network_origin: {
              vpc_configuration: {
                vpc_id: "VpcId", # required
              },
              internet_configuration: {
              },
            },
          },
        },
      },
      sns_topic: {
        topic_policy: "SnsTopicPolicy",
      },
      sqs_queue: {
        queue_policy: "SqsQueuePolicy",
      },
      s3_express_directory_bucket: {
        bucket_policy: "S3ExpressDirectoryBucketPolicy",
        access_points: {
          "S3ExpressDirectoryAccessPointArn" => {
            access_point_policy: "AccessPointPolicy",
            network_origin: {
              vpc_configuration: {
                vpc_id: "VpcId", # required
              },
              internet_configuration: {
              },
            },
          },
        },
      },
      dynamodb_stream: {
        stream_policy: "DynamodbStreamPolicy",
      },
      dynamodb_table: {
        table_policy: "DynamodbTablePolicy",
      },
    },
  },
  client_token: "String",
})


    
      
        
Response structure

      
      

resp.id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the account analyzer used to generate the access
preview. You can only create an access preview for analyzers with an
Account type and Active status.
    
          
        
    • 
      
        
  • 
          :configurations
          (required, Hash<String,Types::Configuration>)
          
            
          
          
            — 
    Access control configuration for your resource that is used to
generate the access preview. The access preview includes findings for
external access allowed to the resource with the proposed access
control configuration. The configuration must contain exactly one
element.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

      

    • #id => String
      • 

    
      
    
    • 
  



  
See Also:

  



  

    
      


149

    		
    
      
# File 'sig/client.rbs', line 149

def create_access_preview: (


    		
  





    
      

  

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

  

  




  

    
Creates an analyzer for your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_analyzer({
  analyzer_name: "AnalyzerName", # required
  type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, ORGANIZATION_UNUSED_ACCESS, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS
  archive_rules: [
    {
      rule_name: "Name", # required
      filter: { # required
        "String" => {
          eq: ["String"],
          neq: ["String"],
          contains: ["String"],
          exists: false,
        },
      },
    },
  ],
  tags: {
    "String" => "String",
  },
  client_token: "String",
  configuration: {
    unused_access: {
      unused_access_age: 1,
      analysis_rule: {
        exclusions: [
          {
            account_ids: ["String"],
            resource_tags: [
              {
                "String" => "String",
              },
            ],
          },
        ],
      },
    },
    internal_access: {
      analysis_rule: {
        inclusions: [
          {
            account_ids: ["String"],
            resource_types: ["AWS::S3::Bucket"], # accepts AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key, AWS::SecretsManager::Secret, AWS::EFS::FileSystem, AWS::EC2::Snapshot, AWS::ECR::Repository, AWS::RDS::DBSnapshot, AWS::RDS::DBClusterSnapshot, AWS::SNS::Topic, AWS::S3Express::DirectoryBucket, AWS::DynamoDB::Table, AWS::DynamoDB::Stream, AWS::IAM::User
            resource_arns: ["String"],
          },
        ],
      },
    },
  },
})


    
      
        
Response structure

      
      

resp.arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer to create.
    
          
        
    • 
      
        
  • 
          :type
          (required, String)
          
            
          
          
            — 
    The type of analyzer to create. You can create only one analyzer per
account per Region. You can create up to 5 analyzers per organization
per Region.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    An array of key-value pairs to apply to the analyzer. You can use the
set of Unicode letters, digits, whitespace, _, ., /, =, +,
and -.
    

    For the tag key, you can specify a value that is 1 to 128 characters
in length and cannot be prefixed with aws:.
    

    For the tag value, you can specify a value that is 0 to 256 characters
in length.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

    A suitable default value is auto-generated. You should normally
not need to pass this option.**
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::AnalyzerConfiguration)
          
            
          
          
            — 
    Specifies the configuration of the analyzer. If the analyzer is an
unused access analyzer, the specified scope of unused access is used
for the configuration. If the analyzer is an internal access analyzer,
the specified internal access analysis rules are used for the
configuration.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


262

    		
    
      
# File 'sig/client.rbs', line 262

def create_analyzer: (


    		
  





    
      

  

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


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the created analyzer.
    
          
        
    • 
      
        
  • 
          :rule_name
          (required, String)
          
            
          
          
            — 
    The name of the rule to create.
    
          
        
    • 
      
        
  • 
          :filter
          (required, Hash<String,Types::Criterion>)
          
            
          
          
            — 
    The criteria 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.**
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


275

    		
    
      
# File 'sig/client.rbs', line 275

def create_archive_rule: (


    		
  





    
      

  

  
    #create_service_linked_analyzer(params = {})  ⇒ Types::CreateServiceLinkedAnalyzerResponse 
  

  

  




  

    
Creates a service-linked analyzer managed by an Amazon Web Services
service. This operation can only be invoked by authorized Amazon Web
Services services. Direct customer invocation returns
AccessDeniedException.


Service-linked analyzers enable Amazon Web Services services to create
and manage analyzers on behalf of customers. The lifecycle of these
analyzers is managed by the calling service.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_service_linked_analyzer({
  type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, ORGANIZATION_UNUSED_ACCESS, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS
  archive_rules: [
    {
      rule_name: "Name", # required
      filter: { # required
        "String" => {
          eq: ["String"],
          neq: ["String"],
          contains: ["String"],
          exists: false,
        },
      },
    },
  ],
  client_token: "String",
  configuration: {
    unused_access: {
      unused_access_age: 1,
      analysis_rule: {
        exclusions: [
          {
            account_ids: ["String"],
            resource_tags: [
              {
                "String" => "String",
              },
            ],
          },
        ],
      },
    },
    internal_access: {
      analysis_rule: {
        inclusions: [
          {
            account_ids: ["String"],
            resource_types: ["AWS::S3::Bucket"], # accepts AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key, AWS::SecretsManager::Secret, AWS::EFS::FileSystem, AWS::EC2::Snapshot, AWS::ECR::Repository, AWS::RDS::DBSnapshot, AWS::RDS::DBClusterSnapshot, AWS::SNS::Topic, AWS::S3Express::DirectoryBucket, AWS::DynamoDB::Table, AWS::DynamoDB::Stream, AWS::IAM::User
            resource_arns: ["String"],
          },
        ],
      },
    },
  },
})


    
      
        
Response structure

      
      

resp.arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :type
          (required, String)
          
            
          
          
            — 
    The type of analyzer to create. Valid values are
ACCOUNT_UNUSED_ACCESS and ORGANIZATION_UNUSED_ACCESS.
    
          
        
    • 
      
        
  • 
          :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.**
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::AnalyzerConfiguration)
          
            
          
          
            — 
    Specifies the configuration of the analyzer. The specified scope of
unused access is used for the configuration.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


293

    		
    
      
# File 'sig/client.rbs', line 293

def create_service_linked_analyzer: (


    		
  





    
      

  

  
    #delete_analyzer(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified analyzer. When you delete an analyzer, IAM
Access Analyzer is disabled for the account or organization 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: "AnalyzerName", # required
  client_token: "String",
})


    
  


  

Parameters:


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


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


304

    		
    
      
# File 'sig/client.rbs', line 304

def delete_analyzer: (


    		
  





    
      

  

  
    #delete_archive_rule(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified archive rule.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer that associated with the archive rule to
delete.
    
          
        
    • 
      
        
  • 
          :rule_name
          (required, String)
          
            
          
          
            — 
    The name of the 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.**
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


311

    		
    
      
# File 'sig/client.rbs', line 311

def delete_archive_rule: (


    		
  





    
      

  

  
    #delete_service_linked_analyzer(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes a service-linked analyzer. This operation can be invoked by
both authorized Amazon Web Services services and customers.


When invoked by a customer, IAM Access Analyzer performs a callback to
the managing service to verify whether the analyzer is still in use
and can be deleted. If the service indicates the analyzer is still in
use, the deletion is rejected with ConflictException.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the service-linked analyzer to delete. Service-linked
analyzer names follow the format
_AccessAnalyzerFor{ServiceName}-{Id}.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


319

    		
    
      
# File 'sig/client.rbs', line 319

def delete_service_linked_analyzer: (


    		
  





    
      

  

  
    #generate_finding_recommendation(params = {})  ⇒ Struct 
  

  

  




  

    
Creates a recommendation for an unused permissions finding.


  





  
  

    
Examples:

    
      
        
Example: Successfully started generating finding recommendation

      
      

resp = client.generate_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "finding-id", 
})

resp.to_h outputs the following:
{
}


    
      
        
Example: Failed field validation for id value

      
      

resp = client.generate_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "!", 
})


    
      
        
Request syntax with placeholder values

      
      

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the finding
recommendation.
    
          
        
    • 
      
        
  • 
          :id
          (required, String)
          
            
          
          
            — 
    The unique ID for the finding recommendation.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


326

    		
    
      
# File 'sig/client.rbs', line 326

def generate_finding_recommendation: (


    		
  





    
      

  

  
    #get_access_preview(params = {})  ⇒ Types::GetAccessPreviewResponse 
  

  

  




  

    
Retrieves information about an access preview for the specified
analyzer.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_access_preview({
  access_preview_id: "AccessPreviewId", # required
  analyzer_arn: "AnalyzerArn", # required
})


    
      
        
Response structure

      
      

resp.access_preview.id #=> String
resp.access_preview.analyzer_arn #=> String
resp.access_preview.configurations #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].ebs_snapshot.user_ids #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].ebs_snapshot.user_ids[0] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].ebs_snapshot.groups #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].ebs_snapshot.groups[0] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].ebs_snapshot.kms_key_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].ecr_repository.repository_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].iam_role.trust_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].efs_file_system.file_system_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.key_policies #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.key_policies["PolicyName"] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].operations #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].operations[0] #=> String, one of "CreateGrant", "Decrypt", "DescribeKey", "Encrypt", "GenerateDataKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateDataKeyWithoutPlaintext", "GetPublicKey", "ReEncryptFrom", "ReEncryptTo", "RetireGrant", "Sign", "Verify"
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].grantee_principal #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].retiring_principal #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].constraints.encryption_context_equals #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].constraints.encryption_context_equals["KmsConstraintsKey"] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].constraints.encryption_context_subset #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0].constraints.encryption_context_subset["KmsConstraintsKey"] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].kms_key.grants[0]. #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_cluster_snapshot.attributes #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_cluster_snapshot.attributes["RdsDbClusterSnapshotAttributeName"]. #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_cluster_snapshot.attributes["RdsDbClusterSnapshotAttributeName"].[0] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_cluster_snapshot.kms_key_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_snapshot.attributes #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_snapshot.attributes["RdsDbSnapshotAttributeName"]. #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_snapshot.attributes["RdsDbSnapshotAttributeName"].[0] #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].rds_db_snapshot.kms_key_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].secrets_manager_secret.kms_key_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].secrets_manager_secret.secret_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_acl_grants #=> Array
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_acl_grants[0].permission #=> String, one of "READ", "WRITE", "READ_ACP", "WRITE_ACP", "FULL_CONTROL"
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_acl_grants[0].grantee.id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_acl_grants[0].grantee.uri #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_public_access_block.ignore_public_acls #=> Boolean
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.bucket_public_access_block.restrict_public_buckets #=> Boolean
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.access_points #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.access_points["AccessPointArn"].access_point_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.access_points["AccessPointArn"].public_access_block.ignore_public_acls #=> Boolean
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.access_points["AccessPointArn"].public_access_block.restrict_public_buckets #=> Boolean
resp.access_preview.configurations["ConfigurationsMapKey"].s3_bucket.access_points["AccessPointArn"].network_origin.vpc_configuration.vpc_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].sns_topic.topic_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].sqs_queue.queue_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_express_directory_bucket.bucket_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_express_directory_bucket.access_points #=> Hash
resp.access_preview.configurations["ConfigurationsMapKey"].s3_express_directory_bucket.access_points["S3ExpressDirectoryAccessPointArn"].access_point_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].s3_express_directory_bucket.access_points["S3ExpressDirectoryAccessPointArn"].network_origin.vpc_configuration.vpc_id #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].dynamodb_stream.stream_policy #=> String
resp.access_preview.configurations["ConfigurationsMapKey"].dynamodb_table.table_policy #=> String
resp.access_preview.created_at #=> Time
resp.access_preview.status #=> String, one of "COMPLETED", "CREATING", "FAILED"
resp.access_preview.status_reason.code #=> String, one of "INTERNAL_ERROR", "INVALID_CONFIGURATION"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :access_preview_id
          (required, String)
          
            
          
          
            — 
    The unique ID for the access preview.
    
          
        
    • 
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the access preview.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


337

    		
    
      
# File 'sig/client.rbs', line 337

def get_access_preview: (


    		
  





    
      

  

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

  

  




  

    
Retrieves information about a resource that was analyzed.


 This action is supported only for external access analyzers.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.resource.resource_arn #=> 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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.resource.created_at #=> Time
resp.resource.analyzed_at #=> Time
resp.resource.updated_at #=> Time
resp.resource.is_public #=> Boolean
resp.resource.actions #=> Array
resp.resource.actions[0] #=> String
resp.resource.shared_via #=> Array
resp.resource.shared_via[0] #=> String
resp.resource.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.resource. #=> String
resp.resource.error #=> String


    
  


  

Parameters:


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


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


348

    		
    
      
# File 'sig/client.rbs', line 348

def get_analyzed_resource: (


    		
  





    
      

  

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

  

  




  

    
Retrieves information about the specified analyzer.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.analyzer.arn #=> String
resp.analyzer.name #=> String
resp.analyzer.type #=> String, one of "ACCOUNT", "ORGANIZATION", "ACCOUNT_UNUSED_ACCESS", "ORGANIZATION_UNUSED_ACCESS", "ACCOUNT_INTERNAL_ACCESS", "ORGANIZATION_INTERNAL_ACCESS"
resp.analyzer.created_at #=> Time
resp.analyzer.last_resource_analyzed #=> String
resp.analyzer.last_resource_analyzed_at #=> Time
resp.analyzer.tags #=> Hash
resp.analyzer.tags["String"] #=> 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.configuration.unused_access.unused_access_age #=> Integer
resp.analyzer.configuration.unused_access.analysis_rule.exclusions #=> Array
resp.analyzer.configuration.unused_access.analysis_rule.exclusions[0]. #=> Array
resp.analyzer.configuration.unused_access.analysis_rule.exclusions[0].[0] #=> String
resp.analyzer.configuration.unused_access.analysis_rule.exclusions[0].resource_tags #=> Array
resp.analyzer.configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0] #=> Hash
resp.analyzer.configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0]["String"] #=> String
resp.analyzer.configuration.internal_access.analysis_rule.inclusions #=> Array
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0]. #=> Array
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0].[0] #=> String
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0].resource_types #=> Array
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0].resource_types[0] #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0].resource_arns #=> Array
resp.analyzer.configuration.internal_access.analysis_rule.inclusions[0].resource_arns[0] #=> String
resp.analyzer.managed_by #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer retrieved.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


359

    		
    
      
# File 'sig/client.rbs', line 359

def get_analyzer: (


    		
  





    
      

  

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

  

  




  

    
Retrieves information about an archive rule.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

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


    
  


  

Parameters:


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


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


369

    		
    
      
# File 'sig/client.rbs', line 369

def get_archive_rule: (


    		
  





    
      

  

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

  

  




  

    
Retrieves information about the specified finding. GetFinding and
GetFindingV2 both use access-analyzer:GetFinding in the Action
element of an IAM policy statement. You must have permission to
perform the access-analyzer:GetFinding action.


 GetFinding is supported only for external access analyzers. You must
use GetFindingV2 for internal and unused access analyzers.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.finding.id #=> String
resp.finding.principal #=> Hash
resp.finding.principal["String"] #=> String
resp.finding.action #=> Array
resp.finding.action[0] #=> String
resp.finding.resource #=> String
resp.finding.is_public #=> Boolean
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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.finding.condition #=> Hash
resp.finding.condition["String"] #=> String
resp.finding.created_at #=> Time
resp.finding.analyzed_at #=> Time
resp.finding.updated_at #=> Time
resp.finding.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.finding. #=> String
resp.finding.error #=> String
resp.finding.sources #=> Array
resp.finding.sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT", "S3_ACCESS_POINT_ACCOUNT"
resp.finding.sources[0].detail.access_point_arn #=> String
resp.finding.sources[0].detail. #=> String
resp.finding.resource_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_RCP", "NOT_APPLICABLE", "APPLIED"


    
  


  

Parameters:


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


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


380

    		
    
      
# File 'sig/client.rbs', line 380

def get_finding: (


    		
  





    
      

  

  
    #get_finding_recommendation(params = {})  ⇒ Types::GetFindingRecommendationResponse 
  

  

  




  

    
Retrieves information about a finding recommendation for the specified
analyzer.


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


  





  
  

    
Examples:

    
      
        
Example: Successfully fetched finding recommendation

      
      

resp = client.get_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "finding-id", 
  max_results: 3, 
  next_token: "token", 
})

resp.to_h outputs the following:
{
  completed_at: Time.parse("2000-01-01T00:00:01Z"), 
  recommendation_type: "UnusedPermissionRecommendation", 
  recommended_steps: [
    {
      unused_permissions_recommended_step: {
        existing_policy_id: "policy-id", 
        recommended_action: "DETACH_POLICY", 
      }, 
    }, 
    {
      unused_permissions_recommended_step: {
        existing_policy_id: "policy-id", 
        recommended_action: "CREATE_POLICY", 
        recommended_policy: "policy-content", 
      }, 
    }, 
  ], 
  resource_arn: "arn:aws:iam::111122223333:role/test", 
  started_at: Time.parse("2000-01-01T00:00:00Z"), 
  status: "SUCCEEDED", 
}


    
      
        
Example: In progress finding recommendation

      
      

resp = client.get_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "finding-id", 
  max_results: 3, 
})

resp.to_h outputs the following:
{
  recommendation_type: "UnusedPermissionRecommendation", 
  resource_arn: "arn:aws:iam::111122223333:role/test", 
  started_at: Time.parse("2000-01-01T00:00:00Z"), 
  status: "IN_PROGRESS", 
}


    
      
        
Example: Failed finding recommendation

      
      

resp = client.get_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "finding-id", 
  max_results: 3, 
})

resp.to_h outputs the following:
{
  completed_at: Time.parse("2000-01-01T00:00:01Z"), 
  error: {
    code: "SERVICE_ERROR", 
    message: "Service error. Please try again.", 
  }, 
  recommendation_type: "UnusedPermissionRecommendation", 
  resource_arn: "arn:aws:iam::111122223333:role/test", 
  started_at: Time.parse("2000-01-01T00:00:00Z"), 
  status: "FAILED", 
}


    
      
        
Example: Failed field validation for id value

      
      

resp = client.get_finding_recommendation({
  analyzer_arn: "arn:aws:access-analyzer:us-east-1:111122223333:analyzer/a", 
  id: "!", 
})


    
      
        
Request syntax with placeholder values

      
      

resp = client.get_finding_recommendation({
  analyzer_arn: "AnalyzerArn", # required
  id: "GetFindingRecommendationRequestIdString", # required
  max_results: 1,
  next_token: "Token",
})


    
      
        
Response structure

      
      

resp.started_at #=> Time
resp.completed_at #=> Time
resp.next_token #=> String
resp.error.code #=> String
resp.error.message #=> String
resp.resource_arn #=> String
resp.recommended_steps #=> Array
resp.recommended_steps[0].unused_permissions_recommended_step.policy_updated_at #=> Time
resp.recommended_steps[0].unused_permissions_recommended_step.recommended_action #=> String, one of "CREATE_POLICY", "DETACH_POLICY"
resp.recommended_steps[0].unused_permissions_recommended_step.recommended_policy #=> String
resp.recommended_steps[0].unused_permissions_recommended_step.existing_policy_id #=> String
resp.recommendation_type #=> String, one of "UnusedPermissionRecommendation"
resp.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the finding
recommendation.
    
          
        
    • 
      
        
  • 
          :id
          (required, String)
          
            
          
          
            — 
    The unique ID for the finding recommendation.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


397

    		
    
      
# File 'sig/client.rbs', line 397

def get_finding_recommendation: (


    		
  





    
      

  

  
    #get_finding_v2(params = {})  ⇒ Types::GetFindingV2Response 
  

  

  




  

    
Retrieves information about the specified finding. GetFinding and
GetFindingV2 both use access-analyzer:GetFinding in the Action
element of an IAM policy statement. You must have permission to
perform the access-analyzer:GetFinding action.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_finding_v2({
  analyzer_arn: "AnalyzerArn", # required
  id: "FindingId", # required
  max_results: 1,
  next_token: "Token",
})


    
      
        
Response structure

      
      

resp.analyzed_at #=> Time
resp.created_at #=> Time
resp.error #=> String
resp.id #=> String
resp.next_token #=> String
resp.resource #=> String
resp.resource_type #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp. #=> String
resp.status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.updated_at #=> Time
resp.finding_details #=> Array
resp.finding_details[0].internal_access_details.action #=> Array
resp.finding_details[0].internal_access_details.action[0] #=> String
resp.finding_details[0].internal_access_details.condition #=> Hash
resp.finding_details[0].internal_access_details.condition["String"] #=> String
resp.finding_details[0].internal_access_details.principal #=> Hash
resp.finding_details[0].internal_access_details.principal["String"] #=> String
resp.finding_details[0].internal_access_details. #=> String
resp.finding_details[0].internal_access_details.access_type #=> String, one of "INTRA_ACCOUNT", "INTRA_ORG"
resp.finding_details[0].internal_access_details.principal_type #=> String, one of "IAM_ROLE", "IAM_USER"
resp.finding_details[0].internal_access_details.sources #=> Array
resp.finding_details[0].internal_access_details.sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT", "S3_ACCESS_POINT_ACCOUNT"
resp.finding_details[0].internal_access_details.sources[0].detail.access_point_arn #=> String
resp.finding_details[0].internal_access_details.sources[0].detail. #=> String
resp.finding_details[0].internal_access_details.resource_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_RCP", "NOT_APPLICABLE", "APPLIED"
resp.finding_details[0].internal_access_details.service_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_SCP", "NOT_APPLICABLE", "APPLIED"
resp.finding_details[0].external_access_details.action #=> Array
resp.finding_details[0].external_access_details.action[0] #=> String
resp.finding_details[0].external_access_details.condition #=> Hash
resp.finding_details[0].external_access_details.condition["String"] #=> String
resp.finding_details[0].external_access_details.is_public #=> Boolean
resp.finding_details[0].external_access_details.principal #=> Hash
resp.finding_details[0].external_access_details.principal["String"] #=> String
resp.finding_details[0].external_access_details.sources #=> Array
resp.finding_details[0].external_access_details.sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT", "S3_ACCESS_POINT_ACCOUNT"
resp.finding_details[0].external_access_details.sources[0].detail.access_point_arn #=> String
resp.finding_details[0].external_access_details.sources[0].detail. #=> String
resp.finding_details[0].external_access_details.resource_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_RCP", "NOT_APPLICABLE", "APPLIED"
resp.finding_details[0].unused_permission_details.actions #=> Array
resp.finding_details[0].unused_permission_details.actions[0].action #=> String
resp.finding_details[0].unused_permission_details.actions[0].last_accessed #=> Time
resp.finding_details[0].unused_permission_details.service_namespace #=> String
resp.finding_details[0].unused_permission_details.last_accessed #=> Time
resp.finding_details[0].unused_iam_user_access_key_details.access_key_id #=> String
resp.finding_details[0].unused_iam_user_access_key_details.last_accessed #=> Time
resp.finding_details[0].unused_iam_role_details.last_accessed #=> Time
resp.finding_details[0].unused_iam_user_password_details.last_accessed #=> Time
resp.finding_type #=> String, one of "ExternalAccess", "UnusedIAMRole", "UnusedIAMUserAccessKey", "UnusedIAMUserPassword", "UnusedPermission", "InternalAccess"


    
  


  

Parameters:


    
  
    
  • 
      
      
      
        (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.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


420

    		
    
      
# File 'sig/client.rbs', line 420

def get_finding_v2: (


    		
  





    
      

  

  
    #get_findings_statistics(params = {})  ⇒ Types::GetFindingsStatisticsResponse 
  

  

  




  

    
Retrieves a list of aggregated finding statistics for an external
access or unused access analyzer.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_findings_statistics({
  analyzer_arn: "AnalyzerArn", # required
})


    
      
        
Response structure

      
      

resp.findings_statistics #=> Array
resp.findings_statistics[0].external_access_findings_statistics.resource_type_statistics #=> Hash
resp.findings_statistics[0].external_access_findings_statistics.resource_type_statistics["ResourceType"].total_active_public #=> Integer
resp.findings_statistics[0].external_access_findings_statistics.resource_type_statistics["ResourceType"]. #=> Integer
resp.findings_statistics[0].external_access_findings_statistics.resource_type_statistics["ResourceType"].total_active_errors #=> Integer
resp.findings_statistics[0].external_access_findings_statistics.total_active_findings #=> Integer
resp.findings_statistics[0].external_access_findings_statistics.total_archived_findings #=> Integer
resp.findings_statistics[0].external_access_findings_statistics.total_resolved_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.resource_type_statistics #=> Hash
resp.findings_statistics[0].internal_access_findings_statistics.resource_type_statistics["ResourceType"].total_active_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.resource_type_statistics["ResourceType"].total_resolved_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.resource_type_statistics["ResourceType"].total_archived_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.total_active_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.total_archived_findings #=> Integer
resp.findings_statistics[0].internal_access_findings_statistics.total_resolved_findings #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.unused_access_type_statistics #=> Array
resp.findings_statistics[0].unused_access_findings_statistics.unused_access_type_statistics[0].unused_access_type #=> String
resp.findings_statistics[0].unused_access_findings_statistics.unused_access_type_statistics[0].total #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.top_accounts #=> Array
resp.findings_statistics[0].unused_access_findings_statistics.top_accounts[0]. #=> String
resp.findings_statistics[0].unused_access_findings_statistics.top_accounts[0].number_of_active_findings #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.top_accounts[0].details #=> Hash
resp.findings_statistics[0].unused_access_findings_statistics.top_accounts[0].details["String"] #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.total_active_findings #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.total_archived_findings #=> Integer
resp.findings_statistics[0].unused_access_findings_statistics.total_resolved_findings #=> Integer
resp.last_updated_at #=> Time


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the statistics.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


434

    		
    
      
# File 'sig/client.rbs', line 434

def get_findings_statistics: (


    		
  





    
      

  

  
    #get_generated_policy(params = {})  ⇒ Types::GetGeneratedPolicyResponse 
  

  

  




  

    
Retrieves the policy that was generated using StartPolicyGeneration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_generated_policy({
  job_id: "JobId", # required
  include_resource_placeholders: false,
  include_service_level_template: false,
})


    
      
        
Response structure

      
      

resp.job_details.job_id #=> String
resp.job_details.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"
resp.job_details.started_on #=> Time
resp.job_details.completed_on #=> Time
resp.job_details.job_error.code #=> String, one of "AUTHORIZATION_ERROR", "RESOURCE_NOT_FOUND_ERROR", "SERVICE_QUOTA_EXCEEDED_ERROR", "SERVICE_ERROR"
resp.job_details.job_error.message #=> String
resp.generated_policy_result.properties.is_complete #=> Boolean
resp.generated_policy_result.properties.principal_arn #=> String
resp.generated_policy_result.properties.cloud_trail_properties.trail_properties #=> Array
resp.generated_policy_result.properties.cloud_trail_properties.trail_properties[0].cloud_trail_arn #=> String
resp.generated_policy_result.properties.cloud_trail_properties.trail_properties[0].regions #=> Array
resp.generated_policy_result.properties.cloud_trail_properties.trail_properties[0].regions[0] #=> String
resp.generated_policy_result.properties.cloud_trail_properties.trail_properties[0].all_regions #=> Boolean
resp.generated_policy_result.properties.cloud_trail_properties.start_time #=> Time
resp.generated_policy_result.properties.cloud_trail_properties.end_time #=> Time
resp.generated_policy_result.generated_policies #=> Array
resp.generated_policy_result.generated_policies[0].policy #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :job_id
          (required, String)
          
            
          
          
            — 
    The JobId that is returned by the StartPolicyGeneration operation.
The JobId can be used with GetGeneratedPolicy to retrieve the
generated policies or used with CancelPolicyGeneration to cancel the
policy generation request.
    
          
        
    • 
      
        
  • 
          :include_resource_placeholders
          (Boolean)
          
            
          
          
            — 
    The level of detail that you want to generate. You can specify whether
to generate policies with placeholders for resource ARNs for actions
that support resource level granularity in policies.
    

    For example, in the resource section of a policy, you can receive a
placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead
of "*".
    
          
        
    • 
      
        
  • 
          :include_service_level_template
          (Boolean)
          
            
          
          
            — 
    The level of detail that you want to generate. You can specify whether
to generate service-level policies.
    

    IAM Access Analyzer uses iam:servicelastaccessed to identify
services that have been used recently to create this service-level
template.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


445

    		
    
      
# File 'sig/client.rbs', line 445

def get_generated_policy: (


    		
  





    
      

  

  
    #list_access_preview_findings(params = {})  ⇒ Types::ListAccessPreviewFindingsResponse 
  

  

  




  

    
Retrieves a list of access preview findings generated by the specified
access preview.


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_access_preview_findings({
  access_preview_id: "AccessPreviewId", # required
  analyzer_arn: "AnalyzerArn", # required
  filter: {
    "String" => {
      eq: ["String"],
      neq: ["String"],
      contains: ["String"],
      exists: false,
    },
  },
  next_token: "Token",
  max_results: 1,
})


    
      
        
Response structure

      
      

resp.findings #=> Array
resp.findings[0].id #=> String
resp.findings[0].existing_finding_id #=> String
resp.findings[0].existing_finding_status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0].principal #=> Hash
resp.findings[0].principal["String"] #=> String
resp.findings[0].action #=> Array
resp.findings[0].action[0] #=> String
resp.findings[0].condition #=> Hash
resp.findings[0].condition["String"] #=> String
resp.findings[0].resource #=> String
resp.findings[0].is_public #=> Boolean
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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.findings[0].created_at #=> Time
resp.findings[0].change_type #=> String, one of "CHANGED", "NEW", "UNCHANGED"
resp.findings[0].status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0]. #=> String
resp.findings[0].error #=> String
resp.findings[0].sources #=> Array
resp.findings[0].sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT", "S3_ACCESS_POINT_ACCOUNT"
resp.findings[0].sources[0].detail.access_point_arn #=> String
resp.findings[0].sources[0].detail. #=> String
resp.findings[0].resource_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_RCP", "NOT_APPLICABLE", "APPLIED"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :access_preview_id
          (required, String)
          
            
          
          
            — 
    The unique ID for the access preview.
    
          
        
    • 
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the access.
    
          
        
    • 
      
        
  • 
          :filter
          (Hash<String,Types::Criterion>)
          
            
          
          
            — 
    Criteria to filter the returned findings.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


458

    		
    
      
# File 'sig/client.rbs', line 458

def list_access_preview_findings: (


    		
  





    
      

  

  
    #list_access_previews(params = {})  ⇒ Types::ListAccessPreviewsResponse 
  

  

  




  

    
Retrieves a list of access previews 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_access_previews({
  analyzer_arn: "AnalyzerArn", # required
  next_token: "Token",
  max_results: 1,
})


    
      
        
Response structure

      
      

resp.access_previews #=> Array
resp.access_previews[0].id #=> String
resp.access_previews[0].analyzer_arn #=> String
resp.access_previews[0].created_at #=> Time
resp.access_previews[0].status #=> String, one of "COMPLETED", "CREATING", "FAILED"
resp.access_previews[0].status_reason.code #=> String, one of "INTERNAL_ERROR", "INVALID_CONFIGURATION"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer used to generate the access preview.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


478

    		
    
      
# File 'sig/client.rbs', line 478

def list_access_previews: (


    		
  





    
      

  

  
    #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
  resource_type: "AWS::S3::Bucket", # accepts AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key, AWS::SecretsManager::Secret, AWS::EFS::FileSystem, AWS::EC2::Snapshot, AWS::ECR::Repository, AWS::RDS::DBSnapshot, AWS::RDS::DBClusterSnapshot, AWS::SNS::Topic, AWS::S3Express::DirectoryBucket, AWS::DynamoDB::Table, AWS::DynamoDB::Stream, AWS::IAM::User
  next_token: "Token",
  max_results: 1,
})


    
      
        
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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer to retrieve a list of analyzed resources
from.
    
          
        
    • 
      
        
  • 
          :resource_type
          (String)
          
            
          
          
            — 
    The type of resource.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


491

    		
    
      
# File 'sig/client.rbs', line 491

def list_analyzed_resources: (


    		
  





    
      

  

  
    #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({
  next_token: "Token",
  max_results: 1,
  type: "ACCOUNT", # accepts ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, ORGANIZATION_UNUSED_ACCESS, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS
})


    
      
        
Response structure

      
      

resp.analyzers #=> Array
resp.analyzers[0].arn #=> String
resp.analyzers[0].name #=> String
resp.analyzers[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ACCOUNT_UNUSED_ACCESS", "ORGANIZATION_UNUSED_ACCESS", "ACCOUNT_INTERNAL_ACCESS", "ORGANIZATION_INTERNAL_ACCESS"
resp.analyzers[0].created_at #=> Time
resp.analyzers[0].last_resource_analyzed #=> String
resp.analyzers[0].last_resource_analyzed_at #=> Time
resp.analyzers[0].tags #=> Hash
resp.analyzers[0].tags["String"] #=> 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].configuration.unused_access.unused_access_age #=> Integer
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions #=> Array
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions[0]. #=> Array
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions[0].[0] #=> String
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions[0].resource_tags #=> Array
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0] #=> Hash
resp.analyzers[0].configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0]["String"] #=> String
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions #=> Array
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0]. #=> Array
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0].[0] #=> String
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0].resource_types #=> Array
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0].resource_types[0] #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0].resource_arns #=> Array
resp.analyzers[0].configuration.internal_access.analysis_rule.inclusions[0].resource_arns[0] #=> String
resp.analyzers[0].managed_by #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
        
  • 
          :type
          (String)
          
            
          
          
            — 
    The type of analyzer.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


505

    		
    
      
# File 'sig/client.rbs', line 505

def list_analyzers: (


    		
  





    
      

  

  
    #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: "AnalyzerName", # required
  next_token: "Token",
  max_results: 1,
})


    
      
        
Response structure

      
      

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer to retrieve rules from.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the request.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


518

    		
    
      
# File 'sig/client.rbs', line 518

def list_archive_rules: (


    		
  





    
      

  

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

  

  




  

    
Retrieves a list of findings generated by the specified analyzer.
ListFindings and ListFindingsV2 both use
access-analyzer:ListFindings in the Action element of an IAM
policy statement. You must have permission to perform the
access-analyzer:ListFindings action.


To learn about filter keys that you can use to retrieve a list of
findings, see IAM Access Analyzer filter keys in the IAM User
Guide.


 ListFindings is supported only for external access analyzers. You must
use ListFindingsV2 for internal and unused access 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_findings({
  analyzer_arn: "AnalyzerArn", # required
  filter: {
    "String" => {
      eq: ["String"],
      neq: ["String"],
      contains: ["String"],
      exists: false,
    },
  },
  sort: {
    attribute_name: "String",
    order_by: "ASC", # accepts ASC, DESC
  },
  next_token: "Token",
  max_results: 1,
})


    
      
        
Response structure

      
      

resp.findings #=> Array
resp.findings[0].id #=> String
resp.findings[0].principal #=> Hash
resp.findings[0].principal["String"] #=> String
resp.findings[0].action #=> Array
resp.findings[0].action[0] #=> String
resp.findings[0].resource #=> String
resp.findings[0].is_public #=> Boolean
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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.findings[0].condition #=> Hash
resp.findings[0].condition["String"] #=> String
resp.findings[0].created_at #=> Time
resp.findings[0].analyzed_at #=> Time
resp.findings[0].updated_at #=> Time
resp.findings[0].status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0]. #=> String
resp.findings[0].error #=> String
resp.findings[0].sources #=> Array
resp.findings[0].sources[0].type #=> String, one of "POLICY", "BUCKET_ACL", "S3_ACCESS_POINT", "S3_ACCESS_POINT_ACCOUNT"
resp.findings[0].sources[0].detail.access_point_arn #=> String
resp.findings[0].sources[0].detail. #=> String
resp.findings[0].resource_control_policy_restriction #=> String, one of "APPLICABLE", "FAILED_TO_EVALUATE_RCP", "NOT_APPLICABLE", "APPLIED"
resp.next_token #=> String


    
  


  

Parameters:


    
  
    
  • 
      
      
      
        (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.
    
          
        
    • 
      
        
  • 
          :sort
          (Types::SortCriteria)
          
            
          
          
            — 
    The sort order for the findings returned.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


531

    		
    
      
# File 'sig/client.rbs', line 531

def list_findings: (


    		
  





    
      

  

  
    #list_findings_v2(params = {})  ⇒ Types::ListFindingsV2Response 
  

  

  




  

    
Retrieves a list of findings generated by the specified analyzer.
ListFindings and ListFindingsV2 both use
access-analyzer:ListFindings in the Action element of an IAM
policy statement. You must have permission to perform the
access-analyzer:ListFindings action.


To learn about filter keys that you can use to retrieve a list of
findings, see IAM Access Analyzer filter keys in the IAM User
Guide.


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_v2({
  analyzer_arn: "AnalyzerArn", # required
  filter: {
    "String" => {
      eq: ["String"],
      neq: ["String"],
      contains: ["String"],
      exists: false,
    },
  },
  max_results: 1,
  next_token: "Token",
  sort: {
    attribute_name: "String",
    order_by: "ASC", # accepts ASC, DESC
  },
})


    
      
        
Response structure

      
      

resp.findings #=> Array
resp.findings[0].analyzed_at #=> Time
resp.findings[0].created_at #=> Time
resp.findings[0].error #=> String
resp.findings[0].id #=> String
resp.findings[0].resource #=> 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", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.findings[0]. #=> String
resp.findings[0].status #=> String, one of "ACTIVE", "ARCHIVED", "RESOLVED"
resp.findings[0].updated_at #=> Time
resp.findings[0].finding_type #=> String, one of "ExternalAccess", "UnusedIAMRole", "UnusedIAMUserAccessKey", "UnusedIAMUserPassword", "UnusedPermission", "InternalAccess"
resp.next_token #=> String


    
  


  

Parameters:


    
  
    
  • 
      
      
      
        (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 criteria used to sort.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


554

    		
    
      
# File 'sig/client.rbs', line 554

def list_findings_v2: (


    		
  





    
      

  

  
    #list_policy_generations(params = {})  ⇒ Types::ListPolicyGenerationsResponse 
  

  

  




  

    
Lists all of the policy generations requested in the last seven days.


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_policy_generations({
  principal_arn: "PrincipalArn",
  max_results: 1,
  next_token: "Token",
})


    
      
        
Response structure

      
      

resp.policy_generations #=> Array
resp.policy_generations[0].job_id #=> String
resp.policy_generations[0].principal_arn #=> String
resp.policy_generations[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"
resp.policy_generations[0].started_on #=> Time
resp.policy_generations[0].completed_on #=> Time
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :principal_arn
          (String)
          
            
          
          
            — 
    The ARN of the IAM entity (user or role) for which you are generating
a policy. Use this with ListGeneratedPolicies to filter the results
to only include results for a specific principal.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


577

    		
    
      
# File 'sig/client.rbs', line 577

def list_policy_generations: (


    		
  





    
      

  

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


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the resource to retrieve tags from.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

      

    • #tags => Hash<String,String>
      • 

    
      
    
    • 
  



  
See Also:

  



  

    
      


589

    		
    
      
# File 'sig/client.rbs', line 589

def list_tags_for_resource: (


    		
  





    
      

  

  
    #start_policy_generation(params = {})  ⇒ Types::StartPolicyGenerationResponse 
  

  

  




  

    
Starts the policy generation request.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_policy_generation({
  policy_generation_details: { # required
    principal_arn: "PrincipalArn", # required
  },
  cloud_trail_details: {
    trails: [ # required
      {
        cloud_trail_arn: "CloudTrailArn", # required
        regions: ["String"],
        all_regions: false,
      },
    ],
    access_role: "RoleArn", # required
    start_time: Time.now, # required
    end_time: Time.now,
  },
  client_token: "String",
})


    
      
        
Response structure

      
      

resp.job_id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :policy_generation_details
          (required, Types::PolicyGenerationDetails)
          
            
          
          
            — 
    Contains the ARN of the IAM entity (user or role) for which you are
generating a policy.
    
          
        
    • 
      
        
  • 
          :cloud_trail_details
          (Types::CloudTrailDetails)
          
            
          
          
            — 
    A CloudTrailDetails object that contains details about a Trail
that you want to analyze to generate policies.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. Idempotency ensures that an API request
completes only once. With an idempotent request, if the original
request completes successfully, the subsequent retries with the same
client token return the result from the original successful request
and they have no additional effect.
    

    If you do not specify a client token, one is automatically generated
by the Amazon Web Services SDK.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


599

    		
    
      
# File 'sig/client.rbs', line 599

def start_policy_generation: (


    		
  





    
      

  

  
    #start_resource_scan(params = {})  ⇒ Struct 
  

  

  




  

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


 This action is supported only for external access analyzers.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
  


  

Parameters:


    
  
    
  • 
      
      
      
        (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.
    
          
        
    • 
      
        
  • 
          :resource_owner_account
          (String)
          
            
          
          
            — 
    The Amazon Web Services account ID that owns the resource. For most
Amazon Web Services resources, the owning account is the account in
which the resource was created.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


620

    		
    
      
# File 'sig/client.rbs', line 620

def start_resource_scan: (


    		
  





    
      

  

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


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


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


631

    		
    
      
# File 'sig/client.rbs', line 631

def tag_resource: (


    		
  





    
      

  

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


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


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


641

    		
    
      
# File 'sig/client.rbs', line 641

def untag_resource: (


    		
  





    
      

  

  
    #update_analyzer(params = {})  ⇒ Types::UpdateAnalyzerResponse 
  

  

  




  

    
Modifies the configuration of an existing analyzer.


 This action is not supported for external access analyzers.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_analyzer({
  analyzer_name: "AnalyzerName", # required
  configuration: {
    unused_access: {
      unused_access_age: 1,
      analysis_rule: {
        exclusions: [
          {
            account_ids: ["String"],
            resource_tags: [
              {
                "String" => "String",
              },
            ],
          },
        ],
      },
    },
    internal_access: {
      analysis_rule: {
        inclusions: [
          {
            account_ids: ["String"],
            resource_types: ["AWS::S3::Bucket"], # accepts AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key, AWS::SecretsManager::Secret, AWS::EFS::FileSystem, AWS::EC2::Snapshot, AWS::ECR::Repository, AWS::RDS::DBSnapshot, AWS::RDS::DBClusterSnapshot, AWS::SNS::Topic, AWS::S3Express::DirectoryBucket, AWS::DynamoDB::Table, AWS::DynamoDB::Stream, AWS::IAM::User
            resource_arns: ["String"],
          },
        ],
      },
    },
  },
})


    
      
        
Response structure

      
      

resp.configuration.unused_access.unused_access_age #=> Integer
resp.configuration.unused_access.analysis_rule.exclusions #=> Array
resp.configuration.unused_access.analysis_rule.exclusions[0]. #=> Array
resp.configuration.unused_access.analysis_rule.exclusions[0].[0] #=> String
resp.configuration.unused_access.analysis_rule.exclusions[0].resource_tags #=> Array
resp.configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0] #=> Hash
resp.configuration.unused_access.analysis_rule.exclusions[0].resource_tags[0]["String"] #=> String
resp.configuration.internal_access.analysis_rule.inclusions #=> Array
resp.configuration.internal_access.analysis_rule.inclusions[0]. #=> Array
resp.configuration.internal_access.analysis_rule.inclusions[0].[0] #=> String
resp.configuration.internal_access.analysis_rule.inclusions[0].resource_types #=> Array
resp.configuration.internal_access.analysis_rule.inclusions[0].resource_types[0] #=> String, one of "AWS::S3::Bucket", "AWS::IAM::Role", "AWS::SQS::Queue", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::KMS::Key", "AWS::SecretsManager::Secret", "AWS::EFS::FileSystem", "AWS::EC2::Snapshot", "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::SNS::Topic", "AWS::S3Express::DirectoryBucket", "AWS::DynamoDB::Table", "AWS::DynamoDB::Stream", "AWS::IAM::User"
resp.configuration.internal_access.analysis_rule.inclusions[0].resource_arns #=> Array
resp.configuration.internal_access.analysis_rule.inclusions[0].resource_arns[0] #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer to modify.
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::AnalyzerConfiguration)
          
            
          
          
            — 
    Contains information about the configuration of an analyzer for an
Amazon Web Services organization or account.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


652

    		
    
      
# File 'sig/client.rbs', line 652

def update_analyzer: (


    		
  





    
      

  

  
    #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: "AnalyzerName", # required
  rule_name: "Name", # required
  filter: { # required
    "String" => {
      eq: ["String"],
      neq: ["String"],
      contains: ["String"],
      exists: false,
    },
  },
  client_token: "String",
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_name
          (required, String)
          
            
          
          
            — 
    The name of the analyzer to update the archive rules for.
    
          
        
    • 
      
        
  • 
          :rule_name
          (required, String)
          
            
          
          
            — 
    The name of the rule to update.
    
          
        
    • 
      
        
  • 
          :filter
          (required, Hash<String,Types::Criterion>)
          
            
          
          
            — 
    A filter to match for the rules to update. Only rules that match the
filter are updated.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


659

    		
    
      
# File 'sig/client.rbs', line 659

def update_archive_rule: (


    		
  





    
      

  

  
    #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
  status: "ACTIVE", # required, accepts ACTIVE, ARCHIVED
  ids: ["FindingId"],
  resource_arn: "ResourceArn",
  client_token: "String",
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :analyzer_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the analyzer that generated the findings to update.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ids
          (Array<String>)
          
            
          
          
            — 
    The IDs of the findings to update.
    
          
        
    • 
      
        
  • 
          :resource_arn
          (String)
          
            
          
          
            — 
    The ARN of the resource identified in the finding.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A client token.
    

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

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


673

    		
    
      
# File 'sig/client.rbs', line 673

def update_findings: (


    		
  





    
      

  

  
    #validate_policy(params = {})  ⇒ Types::ValidatePolicyResponse 
  

  

  




  

    
Requests the validation of a policy and returns a list of findings.
The findings help you identify issues and provide actionable
recommendations to resolve the issue and enable you to author
functional policies that meet security best practices.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.validate_policy({
  locale: "DE", # accepts DE, EN, ES, FR, IT, JA, KO, PT_BR, ZH_CN, ZH_TW
  max_results: 1,
  next_token: "Token",
  policy_document: "PolicyDocument", # required
  policy_type: "IDENTITY_POLICY", # required, accepts IDENTITY_POLICY, RESOURCE_POLICY, SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY
  validate_policy_resource_type: "AWS::S3::Bucket", # accepts AWS::S3::Bucket, AWS::S3::AccessPoint, AWS::S3::MultiRegionAccessPoint, AWS::S3ObjectLambda::AccessPoint, AWS::IAM::AssumeRolePolicyDocument, AWS::DynamoDB::Table
})


    
      
        
Response structure

      
      

resp.findings #=> Array
resp.findings[0].finding_details #=> String
resp.findings[0].finding_type #=> String, one of "ERROR", "SECURITY_WARNING", "SUGGESTION", "WARNING"
resp.findings[0].issue_code #=> String
resp.findings[0].learn_more_link #=> String
resp.findings[0].locations #=> Array
resp.findings[0].locations[0].path #=> Array
resp.findings[0].locations[0].path[0].index #=> Integer
resp.findings[0].locations[0].path[0].key #=> String
resp.findings[0].locations[0].path[0].substring.start #=> Integer
resp.findings[0].locations[0].path[0].substring.length #=> Integer
resp.findings[0].locations[0].path[0].value #=> String
resp.findings[0].locations[0].span.start.line #=> Integer
resp.findings[0].locations[0].span.start.column #=> Integer
resp.findings[0].locations[0].span.start.offset #=> Integer
resp.findings[0].locations[0].span.end.line #=> Integer
resp.findings[0].locations[0].span.end.column #=> Integer
resp.findings[0].locations[0].span.end.offset #=> Integer
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :locale
          (String)
          
            
          
          
            — 
    The locale to use for localizing the findings.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used for pagination of results returned.
    
          
        
    • 
      
        
  • 
          :policy_document
          (required, String)
          
            
          
          
            — 
    The JSON policy document to use as the content for the policy.
    
          
        
    • 
      
        
  • 
          :policy_type
          (required, String)
          
            
          
          
            — 
    The type of policy to validate. Identity policies grant permissions to
IAM principals. Identity policies include managed and inline policies
for IAM roles, users, and groups.
    

    Resource policies grant permissions on Amazon Web Services resources.
Resource policies include trust policies for IAM roles and bucket
policies for Amazon S3 buckets. You can provide a generic input such
as identity policy or resource policy or a specific input such as
managed policy or Amazon S3 bucket policy.
    

    Service control policies (SCPs) are a type of organization policy
attached to an Amazon Web Services organization, organizational unit
(OU), or an account.
    
          
        
    • 
      
        
  • 
          :validate_policy_resource_type
          (String)
          
            
          
          
            — 
    The type of resource to attach to your resource policy. Specify a
value for the policy validation resource type only if the policy type
is RESOURCE_POLICY. For example, to validate a resource policy to
attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for
the policy validation resource type.
    

    For resource types not supported as valid values, IAM Access Analyzer
runs policy checks that apply to all resource policies. For example,
to validate a resource policy to attach to a KMS key, do not specify a
value for the policy validation resource type and IAM Access Analyzer
will run policy checks that apply to all resource policies.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
      
      
        
        
    Returns a response object which responds to the following methods:
    

    
      
    
    • 
  



  
See Also:

  



  

    
      


688

    		
    
      
# File 'sig/client.rbs', line 688

def validate_policy: (


    		
  





    
      

  

  
    #waiter_names  ⇒ 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.



Deprecated. 



  





  

API:


    
  
    
  • 
      
      
      
      
        
        
    private
    
      
    
    • 
  





  

    
      


3075
3076
3077

    		
    
      
# File 'lib/aws-sdk-accessanalyzer/client.rb', line 3075

def waiter_names
  []
end