Skip to content

Start Policy Generation

accessanalyzer_start_policy_generation R Documentation

Starts the policy generation request

Description

Starts the policy generation request.

Usage

accessanalyzer_start_policy_generation(policyGenerationDetails,
  cloudTrailDetails, clientToken)

Arguments

policyGenerationDetails

[required] Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

cloudTrailDetails

A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.

clientToken

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.

Value

A list with the following syntax: 

list(
  jobId = "string"
)

Request syntax

svc$start_policy_generation(
  policyGenerationDetails = list(
    principalArn = "string"
  ),
  cloudTrailDetails = list(
    trails = list(
      list(
        cloudTrailArn = "string",
        regions = list(
          "string"
        ),
        allRegions = TRUE|FALSE
      )
    ),
    accessRole = "string",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    endTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  clientToken = "string"
)