Class: Aws::AccessAnalyzer::Types::StartPolicyPreviewJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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, subsequent retries with the same client token return the result from the original successful request and have no additional effect.

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

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 4804

class StartPolicyPreviewJobRequest < Struct.new(
  :policy_configurations,
  :start_time,
  :end_time,
  :output_s3_uri,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end of the analysis window. If not specified, defaults to the time of the request. The analysis will evaluate CloudTrail events up to this time.

Returns:

  • (Time) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 4804

class StartPolicyPreviewJobRequest < Struct.new(
  :policy_configurations,
  :start_time,
  :end_time,
  :output_s3_uri,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_uri ⇒ String

The Amazon S3 URI where the completed analysis report will be stored. The Amazon S3 bucket must grant access to the IAM Access Analyzer service principal in its resource policy. The report will be stored at the path: outputS3Uri/jobId/timestamp/.

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 4804

class StartPolicyPreviewJobRequest < Struct.new(
  :policy_configurations,
  :start_time,
  :end_time,
  :output_s3_uri,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#policy_configurations ⇒ Array<Types::PolicyConfiguration>

A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.

Returns:



4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 4804

class StartPolicyPreviewJobRequest < Struct.new(
  :policy_configurations,
  :start_time,
  :end_time,
  :output_s3_uri,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start of the CloudTrail event analysis window. The analysis will evaluate events from this time forward.

Returns:

  • (Time) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 4804

class StartPolicyPreviewJobRequest < Struct.new(
  :policy_configurations,
  :start_time,
  :end_time,
  :output_s3_uri,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end