Amazon IAM Access Analyzer · JSON Structure

Iam Access Analyzer Start Policy Generation Request Structure

StartPolicyGenerationRequest schema from AWS IAM Access Analyzer API

Type: object Properties: 3 Required: 1
Access ControlComplianceIAMPolicy ManagementSecurity

StartPolicyGenerationRequest is a JSON Structure definition published by Amazon IAM Access Analyzer, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

policyGenerationDetails cloudTrailDetails clientToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-access-analyzer/refs/heads/main/json-structure/iam-access-analyzer-start-policy-generation-request-structure.json",
  "name": "StartPolicyGenerationRequest",
  "description": "StartPolicyGenerationRequest schema from AWS IAM Access Analyzer API",
  "type": "object",
  "properties": {
    "policyGenerationDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PolicyGenerationDetails"
        },
        {
          "description": "Contains the ARN of the IAM entity (user or role) for which you are generating a policy."
        }
      ]
    },
    "cloudTrailDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CloudTrailDetails"
        },
        {
          "description": "A <code>CloudTrailDetails</code> object that contains details about a <code>Trail</code> that you want to analyze to generate policies."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<p>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.</p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>"
        }
      ]
    }
  },
  "required": [
    "policyGenerationDetails"
  ]
}