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.Types.AccessPreview

Description

 
Synopsis

Documentation

data AccessPreview Source #

Contains information about an access preview.

See: newAccessPreview smart constructor.

Constructors

AccessPreview' 

Fields

  • statusReason :: Maybe AccessPreviewStatusReason

    Provides more details about the current status of the access preview.

    For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

  • id :: Text

    The unique ID for the access preview.

  • analyzerArn :: Text

    The ARN of the analyzer used to generate the access preview.

  • configurations :: HashMap Text Configuration

    A map of resource ARNs for the proposed resource configuration.

  • createdAt :: ISO8601

    The time at which the access preview was created.

  • status :: AccessPreviewStatus

    The status of the access preview.

    • Creating - The access preview creation is in progress.
    • Completed - The access preview is complete. You can preview findings for external access to the resource.
    • Failed - The access preview creation has failed.

Instances

Instances details
FromJSON AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

parseJSON :: Value -> Parser AccessPreview #

parseJSONList :: Value -> Parser [AccessPreview] #

Generic AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Associated Types

type Rep AccessPreview :: Type -> Type #

Methods

from :: AccessPreview -> Rep AccessPreview x #

to :: Rep AccessPreview x -> AccessPreview #

Read AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

readsPrec :: Int -> ReadS AccessPreview #

readList :: ReadS [AccessPreview] #

readPrec :: ReadPrec AccessPreview #

readListPrec :: ReadPrec [AccessPreview] #

Show AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

showsPrec :: Int -> AccessPreview -> ShowS #

show :: AccessPreview -> String #

showList :: [AccessPreview] -> ShowS #

NFData AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

rnf :: AccessPreview -> () #

Eq AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

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

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

Hashable AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

Methods

hashWithSalt :: Int -> AccessPreview -> Int #

hash :: AccessPreview -> Int #

type Rep AccessPreview Source # 
Instance details

Defined in Amazonka.AccessAnalyzer.Types.AccessPreview

type Rep AccessPreview = D1 ('MetaData "AccessPreview" "Amazonka.AccessAnalyzer.Types.AccessPreview" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "AccessPreview'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessPreviewStatusReason)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "analyzerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Configuration)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessPreviewStatus)))))

newAccessPreview Source #

Arguments

:: Text

$sel:id:AccessPreview'

-> Text

$sel:analyzerArn:AccessPreview'

-> UTCTime

$sel:createdAt:AccessPreview'

-> AccessPreviewStatus

$sel:status:AccessPreview'

-> AccessPreview 

Create a value of AccessPreview 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:statusReason:AccessPreview', accessPreview_statusReason - Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

$sel:id:AccessPreview', accessPreview_id - The unique ID for the access preview.

$sel:analyzerArn:AccessPreview', accessPreview_analyzerArn - The ARN of the analyzer used to generate the access preview.

$sel:configurations:AccessPreview', accessPreview_configurations - A map of resource ARNs for the proposed resource configuration.

$sel:createdAt:AccessPreview', accessPreview_createdAt - The time at which the access preview was created.

$sel:status:AccessPreview', accessPreview_status - The status of the access preview.

  • Creating - The access preview creation is in progress.
  • Completed - The access preview is complete. You can preview findings for external access to the resource.
  • Failed - The access preview creation has failed.

accessPreview_statusReason :: Lens' AccessPreview (Maybe AccessPreviewStatusReason) Source #

Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

accessPreview_id :: Lens' AccessPreview Text Source #

The unique ID for the access preview.

accessPreview_analyzerArn :: Lens' AccessPreview Text Source #

The ARN of the analyzer used to generate the access preview.

accessPreview_configurations :: Lens' AccessPreview (HashMap Text Configuration) Source #

A map of resource ARNs for the proposed resource configuration.

accessPreview_createdAt :: Lens' AccessPreview UTCTime Source #

The time at which the access preview was created.

accessPreview_status :: Lens' AccessPreview AccessPreviewStatus Source #

The status of the access preview.

  • Creating - The access preview creation is in progress.
  • Completed - The access preview is complete. You can preview findings for external access to the resource.
  • Failed - The access preview creation has failed.