Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Detective.Types

Contents

Service Configuration
Errors
MemberDisabledReason
MemberStatus
Account
Graph
MemberDetail
UnprocessedAccount

Description

Synopsis

defaultService :: Service
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
newtype MemberDisabledReason where
- MemberDisabledReason' {
  - fromMemberDisabledReason :: Text
  }
- pattern MemberDisabledReason_VOLUME_TOO_HIGH :: MemberDisabledReason
- pattern MemberDisabledReason_VOLUME_UNKNOWN :: MemberDisabledReason
newtype MemberStatus where
- MemberStatus' {
  - fromMemberStatus :: Text
  }
- pattern MemberStatus_ACCEPTED_BUT_DISABLED :: MemberStatus
- pattern MemberStatus_ENABLED :: MemberStatus
- pattern MemberStatus_INVITED :: MemberStatus
- pattern MemberStatus_VERIFICATION_FAILED :: MemberStatus
- pattern MemberStatus_VERIFICATION_IN_PROGRESS :: MemberStatus
data Account = Account' {
- accountId :: Text
- emailAddress :: Text
}
newAccount :: Text -> Text -> Account
account_accountId :: Lens' Account Text
account_emailAddress :: Lens' Account Text
data Graph = Graph' {
- arn :: Maybe Text
- createdTime :: Maybe POSIX
}
newGraph :: Graph
graph_arn :: Lens' Graph (Maybe Text)
graph_createdTime :: Lens' Graph (Maybe UTCTime)
data MemberDetail = MemberDetail' {
- percentOfGraphUtilizationUpdatedTime :: Maybe POSIX
- status :: Maybe MemberStatus
- invitedTime :: Maybe POSIX
- administratorId :: Maybe Text
- graphArn :: Maybe Text
- masterId :: Maybe Text
- accountId :: Maybe Text
- disabledReason :: Maybe MemberDisabledReason
- percentOfGraphUtilization :: Maybe Double
- emailAddress :: Maybe Text
- volumeUsageUpdatedTime :: Maybe POSIX
- updatedTime :: Maybe POSIX
- volumeUsageInBytes :: Maybe Integer
}
newMemberDetail :: MemberDetail
memberDetail_percentOfGraphUtilizationUpdatedTime :: Lens' MemberDetail (Maybe UTCTime)
memberDetail_status :: Lens' MemberDetail (Maybe MemberStatus)
memberDetail_invitedTime :: Lens' MemberDetail (Maybe UTCTime)
memberDetail_administratorId :: Lens' MemberDetail (Maybe Text)
memberDetail_graphArn :: Lens' MemberDetail (Maybe Text)
memberDetail_masterId :: Lens' MemberDetail (Maybe Text)
memberDetail_accountId :: Lens' MemberDetail (Maybe Text)
memberDetail_disabledReason :: Lens' MemberDetail (Maybe MemberDisabledReason)
memberDetail_percentOfGraphUtilization :: Lens' MemberDetail (Maybe Double)
memberDetail_emailAddress :: Lens' MemberDetail (Maybe Text)
memberDetail_volumeUsageUpdatedTime :: Lens' MemberDetail (Maybe UTCTime)
memberDetail_updatedTime :: Lens' MemberDetail (Maybe UTCTime)
memberDetail_volumeUsageInBytes :: Lens' MemberDetail (Maybe Integer)
data UnprocessedAccount = UnprocessedAccount' {
- accountId :: Maybe Text
- reason :: Maybe Text
}
newUnprocessedAccount :: UnprocessedAccount
unprocessedAccount_accountId :: Lens' UnprocessedAccount (Maybe Text)
unprocessedAccount_reason :: Lens' UnprocessedAccount (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2018-10-26 of the Amazon Detective SDK configuration.

Errors

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request parameters are invalid.

_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request attempted an invalid action.

_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

This request cannot be completed for one of the following reasons.

The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was valid but failed because of a problem with the service.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request refers to a nonexistent resource.

MemberDisabledReason

newtype MemberDisabledReason Source #

Constructors

MemberDisabledReason'
Fields fromMemberDisabledReason :: Text

Bundled Patterns

pattern MemberDisabledReason_VOLUME_TOO_HIGH :: MemberDisabledReason
pattern MemberDisabledReason_VOLUME_UNKNOWN :: MemberDisabledReason

Instances

Instances details

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

MemberStatus

newtype MemberStatus Source #

Constructors

MemberStatus'
Fields fromMemberStatus :: Text

Bundled Patterns

pattern MemberStatus_ACCEPTED_BUT_DISABLED :: MemberStatus
pattern MemberStatus_ENABLED :: MemberStatus
pattern MemberStatus_INVITED :: MemberStatus
pattern MemberStatus_VERIFICATION_FAILED :: MemberStatus
pattern MemberStatus_VERIFICATION_IN_PROGRESS :: MemberStatus

Instances

Instances details

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

Account

data Account Source #

An AWS account that is the administrator account of or a member of a behavior graph.

See: newAccount smart constructor.

Constructors

Account'
Fields accountId :: Text The account identifier of the AWS account. emailAddress :: Text The AWS account root user email address for the AWS account.

Instances

Instances details

Eq Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Read Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
Generic Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
NFData Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods rnf :: Account -> () #
Hashable Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
ToJSON Account Source #
Instance details Defined in Amazonka.Detective.Types.Account Methods toJSON :: Account -> Value # toEncoding :: Account -> Encoding # toJSONList :: [Account] -> Value # toEncodingList :: [Account] -> Encoding #
type Rep Account Source #
Instance details Defined in Amazonka.Detective.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.Detective.Types.Account" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAccount Source #

Arguments

:: Text	`$sel:accountId:Account'`
-> Text	`$sel:emailAddress:Account'`
-> Account

Create a value of Account 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:accountId:Account', account_accountId - The account identifier of the AWS account.

$sel:emailAddress:Account', account_emailAddress - The AWS account root user email address for the AWS account.

account_accountId :: Lens' Account Text Source #

The account identifier of the AWS account.

account_emailAddress :: Lens' Account Text Source #

The AWS account root user email address for the AWS account.

Graph

data Graph Source #

A behavior graph in Detective.

See: newGraph smart constructor.

Constructors

Graph'
Fields arn :: Maybe Text The ARN of the behavior graph. createdTime :: Maybe POSIX The date and time that the behavior graph was created. The value is in milliseconds since the epoch.

Instances

Instances details

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

newGraph :: Graph Source #

Create a value of Graph 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:arn:Graph', graph_arn - The ARN of the behavior graph.

$sel:createdTime:Graph', graph_createdTime - The date and time that the behavior graph was created. The value is in milliseconds since the epoch.

graph_arn :: Lens' Graph (Maybe Text) Source #

The ARN of the behavior graph.

graph_createdTime :: Lens' Graph (Maybe UTCTime) Source #

The date and time that the behavior graph was created. The value is in milliseconds since the epoch.

MemberDetail

data MemberDetail Source #

Details about a member account that was invited to contribute to a behavior graph.

See: newMemberDetail smart constructor.

Constructors

MemberDetail'

Fields

percentOfGraphUtilizationUpdatedTime :: Maybe POSIX
The date and time when the graph utilization percentage was last updated.
status :: Maybe MemberStatus
The current membership status of the member account. The status can have one of the following values:
- INVITED - Indicates that the member was sent an invitation but has not yet responded.
- VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
- VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
- ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
- ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph are not included.
invitedTime :: Maybe POSIX
The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
administratorId :: Maybe Text
The AWS account identifier of the administrator account for the behavior graph.
graphArn :: Maybe Text
The ARN of the behavior graph that the member account was invited to.
masterId :: Maybe Text
The AWS account identifier of the administrator account for the behavior graph.
accountId :: Maybe Text
The AWS account identifier for the member account.
disabledReason :: Maybe MemberDisabledReason
For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
The reason can have one of the following values:
- VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.
- VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
percentOfGraphUtilization :: Maybe Double
The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
emailAddress :: Maybe Text
The AWS account root user email address for the member account.
volumeUsageUpdatedTime :: Maybe POSIX
The data and time when the member account data volume was last updated.
updatedTime :: Maybe POSIX
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
volumeUsageInBytes :: Maybe Integer
The data volume in bytes per day for the member account.

Instances

Instances details

Eq MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods (==) :: MemberDetail -> MemberDetail -> Bool # (/=) :: MemberDetail -> MemberDetail -> Bool #
Read MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods readsPrec :: Int -> ReadS MemberDetail # readList :: ReadS [MemberDetail] # readPrec :: ReadPrec MemberDetail # readListPrec :: ReadPrec [MemberDetail] #
Show MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods showsPrec :: Int -> MemberDetail -> ShowS # show :: MemberDetail -> String # showList :: [MemberDetail] -> ShowS #
Generic MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Associated Types type Rep MemberDetail :: Type -> Type # Methods from :: MemberDetail -> Rep MemberDetail x # to :: Rep MemberDetail x -> MemberDetail #
NFData MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods rnf :: MemberDetail -> () #
Hashable MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods hashWithSalt :: Int -> MemberDetail -> Int # hash :: MemberDetail -> Int #
FromJSON MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail Methods parseJSON :: Value -> Parser MemberDetail # parseJSONList :: Value -> Parser [MemberDetail] #
type Rep MemberDetail Source #
Instance details Defined in Amazonka.Detective.Types.MemberDetail type Rep MemberDetail = D1 ('MetaData "MemberDetail" "Amazonka.Detective.Types.MemberDetail" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "MemberDetail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "percentOfGraphUtilizationUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MemberStatus)) :: S1 ('MetaSel ('Just "invitedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "administratorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "graphArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "masterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disabledReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MemberDisabledReason)) :: S1 ('MetaSel ('Just "percentOfGraphUtilization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "volumeUsageUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "updatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "volumeUsageInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))

newMemberDetail :: MemberDetail Source #

Create a value of MemberDetail 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:percentOfGraphUtilizationUpdatedTime:MemberDetail', memberDetail_percentOfGraphUtilizationUpdatedTime - The date and time when the graph utilization percentage was last updated.

$sel:status:MemberDetail', memberDetail_status - The current membership status of the member account. The status can have one of the following values:

INVITED - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

$sel:invitedTime:MemberDetail', memberDetail_invitedTime - The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

$sel:administratorId:MemberDetail', memberDetail_administratorId - The AWS account identifier of the administrator account for the behavior graph.

$sel:graphArn:MemberDetail', memberDetail_graphArn - The ARN of the behavior graph that the member account was invited to.

$sel:masterId:MemberDetail', memberDetail_masterId - The AWS account identifier of the administrator account for the behavior graph.

$sel:accountId:MemberDetail', memberDetail_accountId - The AWS account identifier for the member account.

$sel:disabledReason:MemberDetail', memberDetail_disabledReason - For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.
VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

$sel:percentOfGraphUtilization:MemberDetail', memberDetail_percentOfGraphUtilization - The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.

Note that this is not the percentage of the behavior graph data volume.

For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.

$sel:emailAddress:MemberDetail', memberDetail_emailAddress - The AWS account root user email address for the member account.

$sel:volumeUsageUpdatedTime:MemberDetail', memberDetail_volumeUsageUpdatedTime - The data and time when the member account data volume was last updated.

$sel:updatedTime:MemberDetail', memberDetail_updatedTime - The date and time that the member account was last updated. The value is in milliseconds since the epoch.

$sel:volumeUsageInBytes:MemberDetail', memberDetail_volumeUsageInBytes - The data volume in bytes per day for the member account.

memberDetail_percentOfGraphUtilizationUpdatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #

The date and time when the graph utilization percentage was last updated.

memberDetail_status :: Lens' MemberDetail (Maybe MemberStatus) Source #

The current membership status of the member account. The status can have one of the following values:

INVITED - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

memberDetail_invitedTime :: Lens' MemberDetail (Maybe UTCTime) Source #

The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

memberDetail_administratorId :: Lens' MemberDetail (Maybe Text) Source #

The AWS account identifier of the administrator account for the behavior graph.

memberDetail_graphArn :: Lens' MemberDetail (Maybe Text) Source #

The ARN of the behavior graph that the member account was invited to.

memberDetail_masterId :: Lens' MemberDetail (Maybe Text) Source #

The AWS account identifier of the administrator account for the behavior graph.

memberDetail_accountId :: Lens' MemberDetail (Maybe Text) Source #

The AWS account identifier for the member account.

memberDetail_disabledReason :: Lens' MemberDetail (Maybe MemberDisabledReason) Source #

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.
VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

memberDetail_percentOfGraphUtilization :: Lens' MemberDetail (Maybe Double) Source #

The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.

Note that this is not the percentage of the behavior graph data volume.

For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.

memberDetail_emailAddress :: Lens' MemberDetail (Maybe Text) Source #

The AWS account root user email address for the member account.

memberDetail_volumeUsageUpdatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #

The data and time when the member account data volume was last updated.

memberDetail_updatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #

The date and time that the member account was last updated. The value is in milliseconds since the epoch.

memberDetail_volumeUsageInBytes :: Lens' MemberDetail (Maybe Integer) Source #

The data volume in bytes per day for the member account.

UnprocessedAccount

data UnprocessedAccount Source #

A member account that was included in a request but for which the request could not be processed.

See: newUnprocessedAccount smart constructor.

Constructors

UnprocessedAccount'
Fields accountId :: Maybe Text The AWS account identifier of the member account that was not processed. reason :: Maybe Text The reason that the member account request could not be processed.

Instances

Instances details

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

newUnprocessedAccount :: UnprocessedAccount Source #

Create a value of UnprocessedAccount 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:accountId:UnprocessedAccount', unprocessedAccount_accountId - The AWS account identifier of the member account that was not processed.

$sel:reason:UnprocessedAccount', unprocessedAccount_reason - The reason that the member account request could not be processed.

unprocessedAccount_accountId :: Lens' UnprocessedAccount (Maybe Text) Source #

The AWS account identifier of the member account that was not processed.

unprocessedAccount_reason :: Lens' UnprocessedAccount (Maybe Text) Source #

The reason that the member account request could not be processed.