Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AccessAnalyzer.StartPolicyGeneration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts the policy generation request.

Synopsis

Creating a Request

data StartPolicyGeneration Source #

See: newStartPolicyGeneration smart constructor.

Constructors

StartPolicyGeneration'

Fields

clientToken :: Maybe Text
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.
cloudTrailDetails :: Maybe CloudTrailDetails
A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.
policyGenerationDetails :: PolicyGenerationDetails
Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

Instances

Instances details

ToJSON StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods toJSON :: StartPolicyGeneration -> Value # toEncoding :: StartPolicyGeneration -> Encoding # toJSONList :: [StartPolicyGeneration] -> Value # toEncodingList :: [StartPolicyGeneration] -> Encoding #
ToHeaders StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods toHeaders :: StartPolicyGeneration -> [Header] #
ToPath StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods toPath :: StartPolicyGeneration -> ByteString #
ToQuery StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods toQuery :: StartPolicyGeneration -> QueryString #
AWSRequest StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Associated Types type AWSResponse StartPolicyGeneration # Methods request :: (Service -> Service) -> StartPolicyGeneration -> Request StartPolicyGeneration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartPolicyGeneration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartPolicyGeneration))) #
Generic StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Associated Types type Rep StartPolicyGeneration :: Type -> Type # Methods from :: StartPolicyGeneration -> Rep StartPolicyGeneration x # to :: Rep StartPolicyGeneration x -> StartPolicyGeneration #
Read StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods readsPrec :: Int -> ReadS StartPolicyGeneration # readList :: ReadS [StartPolicyGeneration] # readPrec :: ReadPrec StartPolicyGeneration # readListPrec :: ReadPrec [StartPolicyGeneration] #
Show StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods showsPrec :: Int -> StartPolicyGeneration -> ShowS # show :: StartPolicyGeneration -> String # showList :: [StartPolicyGeneration] -> ShowS #
NFData StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods rnf :: StartPolicyGeneration -> () #
Eq StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods (==) :: StartPolicyGeneration -> StartPolicyGeneration -> Bool # (/=) :: StartPolicyGeneration -> StartPolicyGeneration -> Bool #
Hashable StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods hashWithSalt :: Int -> StartPolicyGeneration -> Int # hash :: StartPolicyGeneration -> Int #
type AWSResponse StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration type AWSResponse StartPolicyGeneration = StartPolicyGenerationResponse
type Rep StartPolicyGeneration Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration type Rep StartPolicyGeneration = D1 ('MetaData "StartPolicyGeneration" "Amazonka.AccessAnalyzer.StartPolicyGeneration" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "StartPolicyGeneration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "cloudTrailDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudTrailDetails)) :: S1 ('MetaSel ('Just "policyGenerationDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PolicyGenerationDetails))))

newStartPolicyGeneration Source #

Arguments

:: PolicyGenerationDetails	`$sel:policyGenerationDetails:StartPolicyGeneration'`
-> StartPolicyGeneration

Create a value of StartPolicyGeneration 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:clientToken:StartPolicyGeneration', startPolicyGeneration_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.

$sel:cloudTrailDetails:StartPolicyGeneration', startPolicyGeneration_cloudTrailDetails - A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.

$sel:policyGenerationDetails:StartPolicyGeneration', startPolicyGeneration_policyGenerationDetails - Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

Request Lenses

startPolicyGeneration_clientToken :: Lens' StartPolicyGeneration (Maybe Text) Source #

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.

startPolicyGeneration_cloudTrailDetails :: Lens' StartPolicyGeneration (Maybe CloudTrailDetails) Source #

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

startPolicyGeneration_policyGenerationDetails :: Lens' StartPolicyGeneration PolicyGenerationDetails Source #

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

Destructuring the Response

data StartPolicyGenerationResponse Source #

See: newStartPolicyGenerationResponse smart constructor.

Constructors

StartPolicyGenerationResponse'
Fields httpStatus :: Int The response's http status code. 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

Generic StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Associated Types type Rep StartPolicyGenerationResponse :: Type -> Type # Methods from :: StartPolicyGenerationResponse -> Rep StartPolicyGenerationResponse x # to :: Rep StartPolicyGenerationResponse x -> StartPolicyGenerationResponse #
Read StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods readsPrec :: Int -> ReadS StartPolicyGenerationResponse # readList :: ReadS [StartPolicyGenerationResponse] # readPrec :: ReadPrec StartPolicyGenerationResponse # readListPrec :: ReadPrec [StartPolicyGenerationResponse] #
Show StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods showsPrec :: Int -> StartPolicyGenerationResponse -> ShowS # show :: StartPolicyGenerationResponse -> String # showList :: [StartPolicyGenerationResponse] -> ShowS #
NFData StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods rnf :: StartPolicyGenerationResponse -> () #
Eq StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration Methods (==) :: StartPolicyGenerationResponse -> StartPolicyGenerationResponse -> Bool # (/=) :: StartPolicyGenerationResponse -> StartPolicyGenerationResponse -> Bool #
type Rep StartPolicyGenerationResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.StartPolicyGeneration type Rep StartPolicyGenerationResponse = D1 ('MetaData "StartPolicyGenerationResponse" "Amazonka.AccessAnalyzer.StartPolicyGeneration" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "StartPolicyGenerationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartPolicyGenerationResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartPolicyGenerationResponse'`
-> Text	`StartPolicyGenerationResponse`
-> StartPolicyGenerationResponse

Create a value of StartPolicyGenerationResponse 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:StartPolicyGenerationResponse', startPolicyGenerationResponse_httpStatus - The response's http status code.

StartPolicyGenerationResponse, startPolicyGenerationResponse_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.

Response Lenses

startPolicyGenerationResponse_httpStatus :: Lens' StartPolicyGenerationResponse Int Source #

The response's http status code.

startPolicyGenerationResponse_jobId :: Lens' StartPolicyGenerationResponse 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.