Class: Aws::AccessAnalyzer::Types::ValidatePolicyRequest

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

Overview

Note:

When making an API call, you may pass ValidatePolicyRequest data as a hash:

{
  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
  validate_policy_resource_type: "AWS::S3::Bucket", # accepts AWS::S3::Bucket, AWS::S3::AccessPoint, AWS::S3::MultiRegionAccessPoint, AWS::S3ObjectLambda::AccessPoint
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#localeString

The locale to use for localizing the findings.

Returns:

  • (String)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in the response.

Returns:

  • (Integer)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A token used for pagination of results returned.

Returns:

  • (String)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#policy_documentString

The JSON policy document to use as the content for the policy.

Returns:

  • (String)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#policy_typeString

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. They also include service-control policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.

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:

  • (String)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#validate_policy_resource_typeString

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:

  • (String)


3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 3520

class ValidatePolicyRequest < Struct.new(
  :locale,
  :max_results,
  :next_token,
  :policy_document,
  :policy_type,
  :validate_policy_resource_type)
  SENSITIVE = []
  include Aws::Structure
end