libZSservicesZSamazonka-accessanalyzerZSamazonka-accessanalyzer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AccessAnalyzer.CreateAccessPreview

Description

Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.

Synopsis

Creating a Request

data CreateAccessPreview Source #

See: newCreateAccessPreview smart constructor.

Constructors

CreateAccessPreview' 

Fields

  • clientToken :: Maybe Text

    A client token.

  • analyzerArn :: Text

    The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

  • configurations :: HashMap Text Configuration

    Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

Instances

Instances details
Eq CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

(==) :: CreateAccessPreview -> CreateAccessPreview -> Bool #

(/=) :: CreateAccessPreview -> CreateAccessPreview -> Bool #

Read CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

readsPrec :: Int -> ReadS CreateAccessPreview #

readList :: ReadS [CreateAccessPreview] #

readPrec :: ReadPrec CreateAccessPreview #

readListPrec :: ReadPrec [CreateAccessPreview] #

Show CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

showsPrec :: Int -> CreateAccessPreview -> ShowS #

show :: CreateAccessPreview -> String #

showList :: [CreateAccessPreview] -> ShowS #

Generic CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Associated Types

type Rep CreateAccessPreview :: Type -> Type #

Methods

from :: CreateAccessPreview -> Rep CreateAccessPreview x #

to :: Rep CreateAccessPreview x -> CreateAccessPreview #

NFData CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

rnf :: CreateAccessPreview -> () #

Hashable CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

hashWithSalt :: Int -> CreateAccessPreview -> Int #

hash :: CreateAccessPreview -> Int #

ToJSON CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

toJSON :: CreateAccessPreview -> Value #

toEncoding :: CreateAccessPreview -> Encoding #

toJSONList :: [CreateAccessPreview] -> Value #

toEncodingList :: [CreateAccessPreview] -> Encoding #

AWSRequest CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Associated Types

type AWSResponse CreateAccessPreview #

Methods

request :: CreateAccessPreview -> Request CreateAccessPreview #

response :: MonadResource m => Logger -> Service -> Proxy CreateAccessPreview -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccessPreview))) #

ToHeaders CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

toHeaders :: CreateAccessPreview -> [Header] #

ToPath CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

toPath :: CreateAccessPreview -> ByteString #

ToQuery CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

toQuery :: CreateAccessPreview -> QueryString #

type Rep CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

type Rep CreateAccessPreview = D1 ('MetaData "CreateAccessPreview" "Amazonka.AccessAnalyzer.CreateAccessPreview" "libZSservicesZSamazonka-accessanalyzerZSamazonka-accessanalyzer" 'False) (C1 ('MetaCons "CreateAccessPreview'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "analyzerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Configuration)))))
type AWSResponse CreateAccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

type AWSResponse CreateAccessPreview = CreateAccessPreviewResponse

newCreateAccessPreview Source #

Arguments

:: Text

$sel:analyzerArn:CreateAccessPreview'

-> CreateAccessPreview 

Create a value of CreateAccessPreview 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:CreateAccessPreview', createAccessPreview_clientToken - A client token.

$sel:analyzerArn:CreateAccessPreview', createAccessPreview_analyzerArn - The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

$sel:configurations:CreateAccessPreview', createAccessPreview_configurations - Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

Request Lenses

createAccessPreview_clientToken :: Lens' CreateAccessPreview (Maybe Text) Source #

A client token.

createAccessPreview_analyzerArn :: Lens' CreateAccessPreview Text Source #

The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

createAccessPreview_configurations :: Lens' CreateAccessPreview (HashMap Text Configuration) Source #

Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

Destructuring the Response

data CreateAccessPreviewResponse Source #

See: newCreateAccessPreviewResponse smart constructor.

Constructors

CreateAccessPreviewResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • id :: Text

    The unique ID for the access preview.

Instances

Instances details
Eq CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

(==) :: CreateAccessPreviewResponse -> CreateAccessPreviewResponse -> Bool #

(/=) :: CreateAccessPreviewResponse -> CreateAccessPreviewResponse -> Bool #

Read CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

readsPrec :: Int -> ReadS CreateAccessPreviewResponse #

readList :: ReadS [CreateAccessPreviewResponse] #

readPrec :: ReadPrec CreateAccessPreviewResponse #

readListPrec :: ReadPrec [CreateAccessPreviewResponse] #

Show CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

showsPrec :: Int -> CreateAccessPreviewResponse -> ShowS #

show :: CreateAccessPreviewResponse -> String #

showList :: [CreateAccessPreviewResponse] -> ShowS #

Generic CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Associated Types

type Rep CreateAccessPreviewResponse :: Type -> Type #

Methods

from :: CreateAccessPreviewResponse -> Rep CreateAccessPreviewResponse x #

to :: Rep CreateAccessPreviewResponse x -> CreateAccessPreviewResponse #

NFData CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

Methods

rnf :: CreateAccessPreviewResponse -> () #

type Rep CreateAccessPreviewResponse Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.CreateAccessPreview

type Rep CreateAccessPreviewResponse = D1 ('MetaData "CreateAccessPreviewResponse" "Amazonka.AccessAnalyzer.CreateAccessPreview" "libZSservicesZSamazonka-accessanalyzerZSamazonka-accessanalyzer" 'False) (C1 ('MetaCons "CreateAccessPreviewResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAccessPreviewResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateAccessPreviewResponse'

-> Text

$sel:id:CreateAccessPreviewResponse'

-> CreateAccessPreviewResponse 

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

$sel:id:CreateAccessPreviewResponse', createAccessPreviewResponse_id - The unique ID for the access preview.

Response Lenses

createAccessPreviewResponse_httpStatus :: Lens' CreateAccessPreviewResponse Int Source #

The response's http status code.

createAccessPreviewResponse_id :: Lens' CreateAccessPreviewResponse Text Source #

The unique ID for the access preview.