| 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.Inspector.PreviewAgents
Description
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
This operation returns paginated results.
Synopsis
- data PreviewAgents = PreviewAgents' {
- nextToken :: Maybe Text
- maxResults :: Maybe Int
- previewAgentsArn :: Text
- newPreviewAgents :: Text -> PreviewAgents
- previewAgents_nextToken :: Lens' PreviewAgents (Maybe Text)
- previewAgents_maxResults :: Lens' PreviewAgents (Maybe Int)
- previewAgents_previewAgentsArn :: Lens' PreviewAgents Text
- data PreviewAgentsResponse = PreviewAgentsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- agentPreviews :: [AgentPreview]
- newPreviewAgentsResponse :: Int -> PreviewAgentsResponse
- previewAgentsResponse_nextToken :: Lens' PreviewAgentsResponse (Maybe Text)
- previewAgentsResponse_httpStatus :: Lens' PreviewAgentsResponse Int
- previewAgentsResponse_agentPreviews :: Lens' PreviewAgentsResponse [AgentPreview]
Creating a Request
data PreviewAgents Source #
See: newPreviewAgents smart constructor.
Constructors
| PreviewAgents' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> PreviewAgents |
Create a value of PreviewAgents 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:nextToken:PreviewAgents', previewAgents_nextToken - You can use this parameter when paginating results. Set the value of
this parameter to null on your first call to the PreviewAgents
action. Subsequent calls to the action fill nextToken in the request
with the value of NextToken from the previous response to continue
listing data.
$sel:maxResults:PreviewAgents', previewAgents_maxResults - You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
$sel:previewAgentsArn:PreviewAgents', previewAgents_previewAgentsArn - The ARN of the assessment target whose agents you want to preview.
Request Lenses
previewAgents_nextToken :: Lens' PreviewAgents (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 PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
previewAgents_maxResults :: Lens' PreviewAgents (Maybe Int) Source #
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
previewAgents_previewAgentsArn :: Lens' PreviewAgents Text Source #
The ARN of the assessment target whose agents you want to preview.
Destructuring the Response
data PreviewAgentsResponse Source #
See: newPreviewAgentsResponse smart constructor.
Constructors
| PreviewAgentsResponse' | |
Fields
| |
Instances
newPreviewAgentsResponse Source #
Create a value of PreviewAgentsResponse 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:nextToken:PreviewAgents', previewAgentsResponse_nextToken - When a response is generated, if there is more data to be listed, this
parameter 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:PreviewAgentsResponse', previewAgentsResponse_httpStatus - The response's http status code.
$sel:agentPreviews:PreviewAgentsResponse', previewAgentsResponse_agentPreviews - The resulting list of agents.
Response Lenses
previewAgentsResponse_nextToken :: Lens' PreviewAgentsResponse (Maybe Text) Source #
When a response is generated, if there is more data to be listed, this parameter 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.
previewAgentsResponse_httpStatus :: Lens' PreviewAgentsResponse Int Source #
The response's http status code.
previewAgentsResponse_agentPreviews :: Lens' PreviewAgentsResponse [AgentPreview] Source #
The resulting list of agents.