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

Contents

Service Configuration
Errors
ControlOperationStatus
ControlOperationType
ControlOperation
EnabledControlSummary

Description

Synopsis

defaultService :: Service
_AccessDeniedException :: AsError a => Fold a ServiceError
_ConflictException :: AsError a => Fold a ServiceError
_InternalServerException :: AsError a => Fold a ServiceError
_ResourceNotFoundException :: AsError a => Fold a ServiceError
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
_ThrottlingException :: AsError a => Fold a ServiceError
_ValidationException :: AsError a => Fold a ServiceError
newtype ControlOperationStatus where
- ControlOperationStatus' {
  - fromControlOperationStatus :: Text
  }
- pattern ControlOperationStatus_FAILED :: ControlOperationStatus
- pattern ControlOperationStatus_IN_PROGRESS :: ControlOperationStatus
- pattern ControlOperationStatus_SUCCEEDED :: ControlOperationStatus
newtype ControlOperationType where
- ControlOperationType' {
  - fromControlOperationType :: Text
  }
- pattern ControlOperationType_DISABLE_CONTROL :: ControlOperationType
- pattern ControlOperationType_ENABLE_CONTROL :: ControlOperationType
data ControlOperation = ControlOperation' {
- endTime :: Maybe ISO8601
- operationType :: Maybe ControlOperationType
- startTime :: Maybe ISO8601
- status :: Maybe ControlOperationStatus
- statusMessage :: Maybe Text
}
newControlOperation :: ControlOperation
controlOperation_endTime :: Lens' ControlOperation (Maybe UTCTime)
controlOperation_operationType :: Lens' ControlOperation (Maybe ControlOperationType)
controlOperation_startTime :: Lens' ControlOperation (Maybe UTCTime)
controlOperation_status :: Lens' ControlOperation (Maybe ControlOperationStatus)
controlOperation_statusMessage :: Lens' ControlOperation (Maybe Text)
data EnabledControlSummary = EnabledControlSummary' {
- controlIdentifier :: Maybe Text
}
newEnabledControlSummary :: EnabledControlSummary
enabledControlSummary_controlIdentifier :: Lens' EnabledControlSummary (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2018-05-10 of the Amazon Control Tower SDK configuration.

Errors

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

User does not have sufficient access to perform this action.

_ConflictException :: AsError a => Fold a ServiceError Source #

Updating or deleting a resource can cause an inconsistent state.

_InternalServerException :: AsError a => Fold a ServiceError Source #

Unexpected error during processing of request.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

Request references a resource which does not exist.

_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #

Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

_ThrottlingException :: AsError a => Fold a ServiceError Source #

Request was denied due to request throttling.

_ValidationException :: AsError a => Fold a ServiceError Source #

The input fails to satisfy the constraints specified by an AWS service.

ControlOperationStatus

newtype ControlOperationStatus Source #

Constructors

ControlOperationStatus'
Fields fromControlOperationStatus :: Text

Bundled Patterns

pattern ControlOperationStatus_FAILED :: ControlOperationStatus
pattern ControlOperationStatus_IN_PROGRESS :: ControlOperationStatus
pattern ControlOperationStatus_SUCCEEDED :: ControlOperationStatus

Instances

Instances details

FromJSON ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods parseJSON :: Value -> Parser ControlOperationStatus # parseJSONList :: Value -> Parser [ControlOperationStatus] #
FromJSONKey ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods fromJSONKey :: FromJSONKeyFunction ControlOperationStatus # fromJSONKeyList :: FromJSONKeyFunction [ControlOperationStatus] #
ToJSON ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toJSON :: ControlOperationStatus -> Value # toEncoding :: ControlOperationStatus -> Encoding # toJSONList :: [ControlOperationStatus] -> Value # toEncodingList :: [ControlOperationStatus] -> Encoding #
ToJSONKey ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toJSONKey :: ToJSONKeyFunction ControlOperationStatus # toJSONKeyList :: ToJSONKeyFunction [ControlOperationStatus] #
ToByteString ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toBS :: ControlOperationStatus -> ByteString #
ToHeader ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toHeader :: HeaderName -> ControlOperationStatus -> [Header] #
ToLog ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods build :: ControlOperationStatus -> ByteStringBuilder #
ToQuery ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toQuery :: ControlOperationStatus -> QueryString #
FromText ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods fromText :: Text -> Either String ControlOperationStatus #
ToText ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toText :: ControlOperationStatus -> Text #
FromXML ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods parseXML :: [Node] -> Either String ControlOperationStatus #
ToXML ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods toXML :: ControlOperationStatus -> XML #
Generic ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Associated Types type Rep ControlOperationStatus :: Type -> Type # Methods from :: ControlOperationStatus -> Rep ControlOperationStatus x # to :: Rep ControlOperationStatus x -> ControlOperationStatus #
Read ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods readsPrec :: Int -> ReadS ControlOperationStatus # readList :: ReadS [ControlOperationStatus] # readPrec :: ReadPrec ControlOperationStatus # readListPrec :: ReadPrec [ControlOperationStatus] #
Show ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods showsPrec :: Int -> ControlOperationStatus -> ShowS # show :: ControlOperationStatus -> String # showList :: [ControlOperationStatus] -> ShowS #
NFData ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods rnf :: ControlOperationStatus -> () #
Eq ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods (==) :: ControlOperationStatus -> ControlOperationStatus -> Bool # (/=) :: ControlOperationStatus -> ControlOperationStatus -> Bool #
Ord ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods compare :: ControlOperationStatus -> ControlOperationStatus -> Ordering # (<) :: ControlOperationStatus -> ControlOperationStatus -> Bool # (<=) :: ControlOperationStatus -> ControlOperationStatus -> Bool # (>) :: ControlOperationStatus -> ControlOperationStatus -> Bool # (>=) :: ControlOperationStatus -> ControlOperationStatus -> Bool # max :: ControlOperationStatus -> ControlOperationStatus -> ControlOperationStatus # min :: ControlOperationStatus -> ControlOperationStatus -> ControlOperationStatus #
Hashable ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus Methods hashWithSalt :: Int -> ControlOperationStatus -> Int # hash :: ControlOperationStatus -> Int #
type Rep ControlOperationStatus Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationStatus type Rep ControlOperationStatus = D1 ('MetaData "ControlOperationStatus" "Amazonka.ControlTower.Types.ControlOperationStatus" "amazonka-controltower-2.0-D5OXoInTRe9EXmxA0ATl1r" 'True) (C1 ('MetaCons "ControlOperationStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromControlOperationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ControlOperationType

newtype ControlOperationType Source #

Constructors

ControlOperationType'
Fields fromControlOperationType :: Text

Bundled Patterns

pattern ControlOperationType_DISABLE_CONTROL :: ControlOperationType
pattern ControlOperationType_ENABLE_CONTROL :: ControlOperationType

Instances

Instances details

FromJSON ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods parseJSON :: Value -> Parser ControlOperationType # parseJSONList :: Value -> Parser [ControlOperationType] #
FromJSONKey ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods fromJSONKey :: FromJSONKeyFunction ControlOperationType # fromJSONKeyList :: FromJSONKeyFunction [ControlOperationType] #
ToJSON ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toJSON :: ControlOperationType -> Value # toEncoding :: ControlOperationType -> Encoding # toJSONList :: [ControlOperationType] -> Value # toEncodingList :: [ControlOperationType] -> Encoding #
ToJSONKey ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toJSONKey :: ToJSONKeyFunction ControlOperationType # toJSONKeyList :: ToJSONKeyFunction [ControlOperationType] #
ToByteString ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toBS :: ControlOperationType -> ByteString #
ToHeader ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toHeader :: HeaderName -> ControlOperationType -> [Header] #
ToLog ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods build :: ControlOperationType -> ByteStringBuilder #
ToQuery ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toQuery :: ControlOperationType -> QueryString #
FromText ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods fromText :: Text -> Either String ControlOperationType #
ToText ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toText :: ControlOperationType -> Text #
FromXML ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods parseXML :: [Node] -> Either String ControlOperationType #
ToXML ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods toXML :: ControlOperationType -> XML #
Generic ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Associated Types type Rep ControlOperationType :: Type -> Type # Methods from :: ControlOperationType -> Rep ControlOperationType x # to :: Rep ControlOperationType x -> ControlOperationType #
Read ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods readsPrec :: Int -> ReadS ControlOperationType # readList :: ReadS [ControlOperationType] # readPrec :: ReadPrec ControlOperationType # readListPrec :: ReadPrec [ControlOperationType] #
Show ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods showsPrec :: Int -> ControlOperationType -> ShowS # show :: ControlOperationType -> String # showList :: [ControlOperationType] -> ShowS #
NFData ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods rnf :: ControlOperationType -> () #
Eq ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods (==) :: ControlOperationType -> ControlOperationType -> Bool # (/=) :: ControlOperationType -> ControlOperationType -> Bool #
Ord ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods compare :: ControlOperationType -> ControlOperationType -> Ordering # (<) :: ControlOperationType -> ControlOperationType -> Bool # (<=) :: ControlOperationType -> ControlOperationType -> Bool # (>) :: ControlOperationType -> ControlOperationType -> Bool # (>=) :: ControlOperationType -> ControlOperationType -> Bool # max :: ControlOperationType -> ControlOperationType -> ControlOperationType # min :: ControlOperationType -> ControlOperationType -> ControlOperationType #
Hashable ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType Methods hashWithSalt :: Int -> ControlOperationType -> Int # hash :: ControlOperationType -> Int #
type Rep ControlOperationType Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperationType type Rep ControlOperationType = D1 ('MetaData "ControlOperationType" "Amazonka.ControlTower.Types.ControlOperationType" "amazonka-controltower-2.0-D5OXoInTRe9EXmxA0ATl1r" 'True) (C1 ('MetaCons "ControlOperationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromControlOperationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ControlOperation

data ControlOperation Source #

An operation performed by the control.

See: newControlOperation smart constructor.

Constructors

ControlOperation'

Fields

endTime :: Maybe ISO8601
The time that the operation finished.
operationType :: Maybe ControlOperationType
One of ENABLE_CONTROL or DISABLE_CONTROL.
startTime :: Maybe ISO8601
The time that the operation began.
status :: Maybe ControlOperationStatus
One of IN_PROGRESS, SUCEEDED, or FAILED.
statusMessage :: Maybe Text
If the operation result is FAILED, this string contains a message explaining why the operation failed.

Instances

Instances details

FromJSON ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods parseJSON :: Value -> Parser ControlOperation # parseJSONList :: Value -> Parser [ControlOperation] #
Generic ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Associated Types type Rep ControlOperation :: Type -> Type # Methods from :: ControlOperation -> Rep ControlOperation x # to :: Rep ControlOperation x -> ControlOperation #
Read ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods readsPrec :: Int -> ReadS ControlOperation # readList :: ReadS [ControlOperation] # readPrec :: ReadPrec ControlOperation # readListPrec :: ReadPrec [ControlOperation] #
Show ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods showsPrec :: Int -> ControlOperation -> ShowS # show :: ControlOperation -> String # showList :: [ControlOperation] -> ShowS #
NFData ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods rnf :: ControlOperation -> () #
Eq ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods (==) :: ControlOperation -> ControlOperation -> Bool # (/=) :: ControlOperation -> ControlOperation -> Bool #
Hashable ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation Methods hashWithSalt :: Int -> ControlOperation -> Int # hash :: ControlOperation -> Int #
type Rep ControlOperation Source #
Instance details Defined in Amazonka.ControlTower.Types.ControlOperation type Rep ControlOperation = D1 ('MetaData "ControlOperation" "Amazonka.ControlTower.Types.ControlOperation" "amazonka-controltower-2.0-D5OXoInTRe9EXmxA0ATl1r" 'False) (C1 ('MetaCons "ControlOperation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "operationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ControlOperationType))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ControlOperationStatus)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newControlOperation :: ControlOperation Source #

Create a value of ControlOperation 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:endTime:ControlOperation', controlOperation_endTime - The time that the operation finished.

$sel:operationType:ControlOperation', controlOperation_operationType - One of ENABLE_CONTROL or DISABLE_CONTROL.

$sel:startTime:ControlOperation', controlOperation_startTime - The time that the operation began.

$sel:status:ControlOperation', controlOperation_status - One of IN_PROGRESS, SUCEEDED, or FAILED.

$sel:statusMessage:ControlOperation', controlOperation_statusMessage - If the operation result is FAILED, this string contains a message explaining why the operation failed.

controlOperation_endTime :: Lens' ControlOperation (Maybe UTCTime) Source #

The time that the operation finished.

controlOperation_operationType :: Lens' ControlOperation (Maybe ControlOperationType) Source #

One of ENABLE_CONTROL or DISABLE_CONTROL.

controlOperation_startTime :: Lens' ControlOperation (Maybe UTCTime) Source #

The time that the operation began.

controlOperation_status :: Lens' ControlOperation (Maybe ControlOperationStatus) Source #

One of IN_PROGRESS, SUCEEDED, or FAILED.

controlOperation_statusMessage :: Lens' ControlOperation (Maybe Text) Source #

If the operation result is FAILED, this string contains a message explaining why the operation failed.

EnabledControlSummary

data EnabledControlSummary Source #

A summary of enabled controls.

See: newEnabledControlSummary smart constructor.

Constructors

EnabledControlSummary'
Fields controlIdentifier :: Maybe Text The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.

Instances

Instances details

FromJSON EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods parseJSON :: Value -> Parser EnabledControlSummary # parseJSONList :: Value -> Parser [EnabledControlSummary] #
Generic EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Associated Types type Rep EnabledControlSummary :: Type -> Type # Methods from :: EnabledControlSummary -> Rep EnabledControlSummary x # to :: Rep EnabledControlSummary x -> EnabledControlSummary #
Read EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods readsPrec :: Int -> ReadS EnabledControlSummary # readList :: ReadS [EnabledControlSummary] # readPrec :: ReadPrec EnabledControlSummary # readListPrec :: ReadPrec [EnabledControlSummary] #
Show EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods showsPrec :: Int -> EnabledControlSummary -> ShowS # show :: EnabledControlSummary -> String # showList :: [EnabledControlSummary] -> ShowS #
NFData EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods rnf :: EnabledControlSummary -> () #
Eq EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods (==) :: EnabledControlSummary -> EnabledControlSummary -> Bool # (/=) :: EnabledControlSummary -> EnabledControlSummary -> Bool #
Hashable EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary Methods hashWithSalt :: Int -> EnabledControlSummary -> Int # hash :: EnabledControlSummary -> Int #
type Rep EnabledControlSummary Source #
Instance details Defined in Amazonka.ControlTower.Types.EnabledControlSummary type Rep EnabledControlSummary = D1 ('MetaData "EnabledControlSummary" "Amazonka.ControlTower.Types.EnabledControlSummary" "amazonka-controltower-2.0-D5OXoInTRe9EXmxA0ATl1r" 'False) (C1 ('MetaCons "EnabledControlSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "controlIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEnabledControlSummary :: EnabledControlSummary Source #

Create a value of EnabledControlSummary 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:controlIdentifier:EnabledControlSummary', enabledControlSummary_controlIdentifier - The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.

enabledControlSummary_controlIdentifier :: Lens' EnabledControlSummary (Maybe Text) Source #

The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.