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.Inspector.GetExclusionsPreview

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Synopsis

data GetExclusionsPreview = GetExclusionsPreview' {
- locale :: Maybe Locale
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- assessmentTemplateArn :: Text
- previewToken :: Text
}
newGetExclusionsPreview :: Text -> Text -> GetExclusionsPreview
getExclusionsPreview_locale :: Lens' GetExclusionsPreview (Maybe Locale)
getExclusionsPreview_maxResults :: Lens' GetExclusionsPreview (Maybe Int)
getExclusionsPreview_nextToken :: Lens' GetExclusionsPreview (Maybe Text)
getExclusionsPreview_assessmentTemplateArn :: Lens' GetExclusionsPreview Text
getExclusionsPreview_previewToken :: Lens' GetExclusionsPreview Text
data GetExclusionsPreviewResponse = GetExclusionsPreviewResponse' {
- exclusionPreviews :: Maybe [ExclusionPreview]
- nextToken :: Maybe Text
- httpStatus :: Int
- previewStatus :: PreviewStatus
}
newGetExclusionsPreviewResponse :: Int -> PreviewStatus -> GetExclusionsPreviewResponse
getExclusionsPreviewResponse_exclusionPreviews :: Lens' GetExclusionsPreviewResponse (Maybe [ExclusionPreview])
getExclusionsPreviewResponse_nextToken :: Lens' GetExclusionsPreviewResponse (Maybe Text)
getExclusionsPreviewResponse_httpStatus :: Lens' GetExclusionsPreviewResponse Int
getExclusionsPreviewResponse_previewStatus :: Lens' GetExclusionsPreviewResponse PreviewStatus

Creating a Request

data GetExclusionsPreview Source #

See: newGetExclusionsPreview smart constructor.

Constructors

GetExclusionsPreview'

Fields

locale :: Maybe Locale
The locale into which you want to translate the exclusion's title, description, and recommendation.
maxResults :: Maybe Int
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.
nextToken :: Maybe Text
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
assessmentTemplateArn :: Text
The ARN that specifies the assessment template for which the exclusions preview was requested.
previewToken :: Text
The unique identifier associated of the exclusions preview.

Instances

Instances details

ToJSON GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods toJSON :: GetExclusionsPreview -> Value # toEncoding :: GetExclusionsPreview -> Encoding # toJSONList :: [GetExclusionsPreview] -> Value # toEncodingList :: [GetExclusionsPreview] -> Encoding #
ToHeaders GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods toHeaders :: GetExclusionsPreview -> [Header] #
ToPath GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods toPath :: GetExclusionsPreview -> ByteString #
ToQuery GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods toQuery :: GetExclusionsPreview -> QueryString #
AWSRequest GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Associated Types type AWSResponse GetExclusionsPreview # Methods request :: (Service -> Service) -> GetExclusionsPreview -> Request GetExclusionsPreview # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetExclusionsPreview -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetExclusionsPreview))) #
Generic GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Associated Types type Rep GetExclusionsPreview :: Type -> Type # Methods from :: GetExclusionsPreview -> Rep GetExclusionsPreview x # to :: Rep GetExclusionsPreview x -> GetExclusionsPreview #
Read GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods readsPrec :: Int -> ReadS GetExclusionsPreview # readList :: ReadS [GetExclusionsPreview] # readPrec :: ReadPrec GetExclusionsPreview # readListPrec :: ReadPrec [GetExclusionsPreview] #
Show GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods showsPrec :: Int -> GetExclusionsPreview -> ShowS # show :: GetExclusionsPreview -> String # showList :: [GetExclusionsPreview] -> ShowS #
NFData GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods rnf :: GetExclusionsPreview -> () #
Eq GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods (==) :: GetExclusionsPreview -> GetExclusionsPreview -> Bool # (/=) :: GetExclusionsPreview -> GetExclusionsPreview -> Bool #
Hashable GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods hashWithSalt :: Int -> GetExclusionsPreview -> Int # hash :: GetExclusionsPreview -> Int #
type AWSResponse GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview type AWSResponse GetExclusionsPreview = GetExclusionsPreviewResponse
type Rep GetExclusionsPreview Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview type Rep GetExclusionsPreview = D1 ('MetaData "GetExclusionsPreview" "Amazonka.Inspector.GetExclusionsPreview" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "GetExclusionsPreview'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "assessmentTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "previewToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetExclusionsPreview Source #

Arguments

:: Text	`GetExclusionsPreview`
-> Text	`$sel:previewToken:GetExclusionsPreview'`
-> GetExclusionsPreview

Create a value of GetExclusionsPreview 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:locale:GetExclusionsPreview', getExclusionsPreview_locale - The locale into which you want to translate the exclusion's title, description, and recommendation.

$sel:maxResults:GetExclusionsPreview', getExclusionsPreview_maxResults - You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

GetExclusionsPreview, getExclusionsPreview_nextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

GetExclusionsPreview, getExclusionsPreview_assessmentTemplateArn - The ARN that specifies the assessment template for which the exclusions preview was requested.

$sel:previewToken:GetExclusionsPreview', getExclusionsPreview_previewToken - The unique identifier associated of the exclusions preview.

Request Lenses

getExclusionsPreview_locale :: Lens' GetExclusionsPreview (Maybe Locale) Source #

The locale into which you want to translate the exclusion's title, description, and recommendation.

getExclusionsPreview_maxResults :: Lens' GetExclusionsPreview (Maybe Int) Source #

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

getExclusionsPreview_nextToken :: Lens' GetExclusionsPreview (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

getExclusionsPreview_assessmentTemplateArn :: Lens' GetExclusionsPreview Text Source #

The ARN that specifies the assessment template for which the exclusions preview was requested.

getExclusionsPreview_previewToken :: Lens' GetExclusionsPreview Text Source #

The unique identifier associated of the exclusions preview.

Destructuring the Response

data GetExclusionsPreviewResponse Source #

See: newGetExclusionsPreviewResponse smart constructor.

Constructors

GetExclusionsPreviewResponse'

Fields

exclusionPreviews :: Maybe [ExclusionPreview]
Information about the exclusions included in the preview.
nextToken :: Maybe Text
When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
httpStatus :: Int
The response's http status code.
previewStatus :: PreviewStatus
Specifies the status of the request to generate an exclusions preview.

Instances

Instances details

Generic GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Associated Types type Rep GetExclusionsPreviewResponse :: Type -> Type # Methods from :: GetExclusionsPreviewResponse -> Rep GetExclusionsPreviewResponse x # to :: Rep GetExclusionsPreviewResponse x -> GetExclusionsPreviewResponse #
Read GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods readsPrec :: Int -> ReadS GetExclusionsPreviewResponse # readList :: ReadS [GetExclusionsPreviewResponse] # readPrec :: ReadPrec GetExclusionsPreviewResponse # readListPrec :: ReadPrec [GetExclusionsPreviewResponse] #
Show GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods showsPrec :: Int -> GetExclusionsPreviewResponse -> ShowS # show :: GetExclusionsPreviewResponse -> String # showList :: [GetExclusionsPreviewResponse] -> ShowS #
NFData GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods rnf :: GetExclusionsPreviewResponse -> () #
Eq GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview Methods (==) :: GetExclusionsPreviewResponse -> GetExclusionsPreviewResponse -> Bool # (/=) :: GetExclusionsPreviewResponse -> GetExclusionsPreviewResponse -> Bool #
type Rep GetExclusionsPreviewResponse Source #
Instance details Defined in Amazonka.Inspector.GetExclusionsPreview type Rep GetExclusionsPreviewResponse = D1 ('MetaData "GetExclusionsPreviewResponse" "Amazonka.Inspector.GetExclusionsPreview" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "GetExclusionsPreviewResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exclusionPreviews") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExclusionPreview])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "previewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PreviewStatus))))

newGetExclusionsPreviewResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetExclusionsPreviewResponse'`
-> PreviewStatus	`$sel:previewStatus:GetExclusionsPreviewResponse'`
-> GetExclusionsPreviewResponse

Create a value of GetExclusionsPreviewResponse 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:exclusionPreviews:GetExclusionsPreviewResponse', getExclusionsPreviewResponse_exclusionPreviews - Information about the exclusions included in the preview.

GetExclusionsPreview, getExclusionsPreviewResponse_nextToken - When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

$sel:httpStatus:GetExclusionsPreviewResponse', getExclusionsPreviewResponse_httpStatus - The response's http status code.

$sel:previewStatus:GetExclusionsPreviewResponse', getExclusionsPreviewResponse_previewStatus - Specifies the status of the request to generate an exclusions preview.

Response Lenses

getExclusionsPreviewResponse_exclusionPreviews :: Lens' GetExclusionsPreviewResponse (Maybe [ExclusionPreview]) Source #

Information about the exclusions included in the preview.

getExclusionsPreviewResponse_nextToken :: Lens' GetExclusionsPreviewResponse (Maybe Text) Source #

When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

getExclusionsPreviewResponse_httpStatus :: Lens' GetExclusionsPreviewResponse Int Source #

The response's http status code.

getExclusionsPreviewResponse_previewStatus :: Lens' GetExclusionsPreviewResponse PreviewStatus Source #

Specifies the status of the request to generate an exclusions preview.