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.MacieV2.Types.AllowListStatus

Description

Synopsis

data AllowListStatus = AllowListStatus' {
- description :: Maybe Text
- code :: AllowListStatusCode
}
newAllowListStatus :: AllowListStatusCode -> AllowListStatus
allowListStatus_description :: Lens' AllowListStatus (Maybe Text)
allowListStatus_code :: Lens' AllowListStatus AllowListStatusCode

Documentation

data AllowListStatus Source #

Provides information about the current status of an allow list, which indicates whether Amazon Macie can access and use the list's criteria.

See: newAllowListStatus smart constructor.

Constructors

AllowListStatus'

Fields

description :: Maybe Text
A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list's criteria.
code :: AllowListStatusCode
The current status of the allow list. If the list's criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.
If the list's criteria specify an S3 object, possible values are:
- OK - Macie can retrieve and parse the contents of the object.
- S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.
- S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names.
- S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and object names.
- S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file.
- S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again.
- S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an KMS key that you're not allowed to use. Work with your Amazon Web Services administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use.
- UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.

Instances

Instances details

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

newAllowListStatus Source #

Arguments

:: AllowListStatusCode	`$sel:code:AllowListStatus'`
-> AllowListStatus

Create a value of AllowListStatus 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:description:AllowListStatus', allowListStatus_description - A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list's criteria.

$sel:code:AllowListStatus', allowListStatus_code - The current status of the allow list. If the list's criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.

If the list's criteria specify an S3 object, possible values are:

OK - Macie can retrieve and parse the contents of the object.
S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.
S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names.
S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and object names.
S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file.
S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again.
S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an KMS key that you're not allowed to use. Work with your Amazon Web Services administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use.
UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.

allowListStatus_description :: Lens' AllowListStatus (Maybe Text) Source #

A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list's criteria.

allowListStatus_code :: Lens' AllowListStatus AllowListStatusCode Source #

The current status of the allow list. If the list's criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.

If the list's criteria specify an S3 object, possible values are:

OK - Macie can retrieve and parse the contents of the object.
S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.
S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names.
S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and object names.
S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file.
S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again.
S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an KMS key that you're not allowed to use. Work with your Amazon Web Services administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use.
UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.