amazonka-accessanalyzer-2.0: Amazon Access Analyzer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AccessAnalyzer.GetGeneratedPolicy

Description

Retrieves the policy that was generated using StartPolicyGeneration.

Synopsis

Creating a Request

data GetGeneratedPolicy Source #

See: newGetGeneratedPolicy smart constructor.

Constructors

GetGeneratedPolicy' 

Fields

  • includeResourcePlaceholders :: Maybe Bool

    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 :: Maybe Bool

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

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

  • jobId :: Text

    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.

Instances

Instances details
ToHeaders GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

ToPath GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

ToQuery GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

AWSRequest GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Associated Types

type AWSResponse GetGeneratedPolicy #

Generic GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Associated Types

type Rep GetGeneratedPolicy :: Type -> Type #

Read GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Show GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

NFData GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Methods

rnf :: GetGeneratedPolicy -> () #

Eq GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Hashable GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

type AWSResponse GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

type Rep GetGeneratedPolicy Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

type Rep GetGeneratedPolicy = D1 ('MetaData "GetGeneratedPolicy" "Amazonka.AccessAnalyzer.GetGeneratedPolicy" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "GetGeneratedPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeResourcePlaceholders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "includeServiceLevelTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetGeneratedPolicy Source #

Create a value of GetGeneratedPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeResourcePlaceholders:GetGeneratedPolicy', getGeneratedPolicy_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 "*".

$sel:includeServiceLevelTemplate:GetGeneratedPolicy', getGeneratedPolicy_includeServiceLevelTemplate - The level of detail that you want to generate. You can specify whether to generate service-level policies.

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

GetGeneratedPolicy, getGeneratedPolicy_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.

Request Lenses

getGeneratedPolicy_includeResourcePlaceholders :: Lens' GetGeneratedPolicy (Maybe Bool) Source #

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

getGeneratedPolicy_includeServiceLevelTemplate :: Lens' GetGeneratedPolicy (Maybe Bool) Source #

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

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

getGeneratedPolicy_jobId :: Lens' GetGeneratedPolicy Text Source #

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.

Destructuring the Response

data GetGeneratedPolicyResponse Source #

See: newGetGeneratedPolicyResponse smart constructor.

Constructors

GetGeneratedPolicyResponse' 

Fields

Instances

Instances details
Generic GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Associated Types

type Rep GetGeneratedPolicyResponse :: Type -> Type #

Read GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Show GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

NFData GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

Eq GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

type Rep GetGeneratedPolicyResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.GetGeneratedPolicy

type Rep GetGeneratedPolicyResponse = D1 ('MetaData "GetGeneratedPolicyResponse" "Amazonka.AccessAnalyzer.GetGeneratedPolicy" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "GetGeneratedPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "jobDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobDetails) :*: S1 ('MetaSel ('Just "generatedPolicyResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeneratedPolicyResult))))

newGetGeneratedPolicyResponse Source #

Create a value of GetGeneratedPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetGeneratedPolicyResponse', getGeneratedPolicyResponse_httpStatus - The response's http status code.

$sel:jobDetails:GetGeneratedPolicyResponse', getGeneratedPolicyResponse_jobDetails - A GeneratedPolicyDetails object that contains details about the generated policy.

$sel:generatedPolicyResult:GetGeneratedPolicyResponse', getGeneratedPolicyResponse_generatedPolicyResult - A GeneratedPolicyResult object that contains the generated policies and associated details.

Response Lenses

getGeneratedPolicyResponse_jobDetails :: Lens' GetGeneratedPolicyResponse JobDetails Source #

A GeneratedPolicyDetails object that contains details about the generated policy.

getGeneratedPolicyResponse_generatedPolicyResult :: Lens' GetGeneratedPolicyResponse GeneratedPolicyResult Source #

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