GetGeneratedPolicy - Access Analyzer

GetGeneratedPolicy

Retrieves the policy that was generated using StartPolicyGeneration.

Request Syntax

GET /policy/generation/jobId?includeResourcePlaceholders=includeResourcePlaceholders&includeServiceLevelTemplate=includeServiceLevelTemplate HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

includeResourcePlaceholders

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 "*".

includeServiceLevelTemplate

The level of detail that you want to generate. You can specify whether to generate service-level policies.

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

jobId

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.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "generatedPolicyResult": { "generatedPolicies": [ { "policy": "string" } ], "properties": { "cloudTrailProperties": { "endTime": number, "startTime": number, "trailProperties": [ { "allRegions": boolean, "cloudTrailArn": "string", "regions": [ "string" ] } ] }, "isComplete": boolean, "principalArn": "string" } }, "jobDetails": { "completedOn": number, "jobError": { "code": "string", "message": "string" }, "jobId": "string", "startedOn": number, "status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

generatedPolicyResult

A GeneratedPolicyResult object that contains the generated policies and associated details.

Type: GeneratedPolicyResult object

jobDetails

A GeneratedPolicyDetails object that contains details about the generated policy.

Type: JobDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Internal server error.

HTTP Status Code: 500

ThrottlingException

Throttling limit exceeded error.

HTTP Status Code: 429

ValidationException

Validation exception error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: