libZSservicesZSamazonka-inspectorZSamazonka-inspector
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data PreviewAgents Source #

See: newPreviewAgents smart constructor.

Constructors

PreviewAgents' 

Fields

  • 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 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.

  • maxResults :: Maybe Int

    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.

  • previewAgentsArn :: Text

    The ARN of the assessment target whose agents you want to preview.

Instances

Instances details
Eq PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Read PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Show PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Generic PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Associated Types

type Rep PreviewAgents :: Type -> Type #

NFData PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Methods

rnf :: PreviewAgents -> () #

Hashable PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

ToJSON PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

AWSPager PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

AWSRequest PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Associated Types

type AWSResponse PreviewAgents #

ToHeaders PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

ToPath PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

ToQuery PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

type Rep PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

type Rep PreviewAgents = D1 ('MetaData "PreviewAgents" "Amazonka.Inspector.PreviewAgents" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "PreviewAgents'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "previewAgentsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse PreviewAgents Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

newPreviewAgents Source #

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

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

  • agentPreviews :: [AgentPreview]

    The resulting list of agents.

Instances

Instances details
Eq PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Read PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Show PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Generic PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Associated Types

type Rep PreviewAgentsResponse :: Type -> Type #

NFData PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

Methods

rnf :: PreviewAgentsResponse -> () #

type Rep PreviewAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.PreviewAgents

type Rep PreviewAgentsResponse = D1 ('MetaData "PreviewAgentsResponse" "Amazonka.Inspector.PreviewAgents" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "PreviewAgentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agentPreviews") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AgentPreview]))))

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.