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

Description

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssessmentRunAgents Source #

See: newListAssessmentRunAgents smart constructor.

Constructors

ListAssessmentRunAgents' 

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 ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

  • filter' :: Maybe AgentFilter

    You can use this parameter to specify a subset of data to be included in the action's response.

    For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

  • maxResults :: Maybe Int

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

  • assessmentRunArn :: Text

    The ARN that specifies the assessment run whose agents you want to list.

Instances

Instances details
Eq ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Read ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Show ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Generic ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Associated Types

type Rep ListAssessmentRunAgents :: Type -> Type #

NFData ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Methods

rnf :: ListAssessmentRunAgents -> () #

Hashable ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

ToJSON ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

AWSPager ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

AWSRequest ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

ToHeaders ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

ToPath ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

ToQuery ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

type Rep ListAssessmentRunAgents Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

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

Defined in Amazonka.Inspector.ListAssessmentRunAgents

newListAssessmentRunAgents Source #

Create a value of ListAssessmentRunAgents 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:ListAssessmentRunAgents', listAssessmentRunAgents_nextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents 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:filter':ListAssessmentRunAgents', listAssessmentRunAgents_filter - You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

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

$sel:assessmentRunArn:ListAssessmentRunAgents', listAssessmentRunAgents_assessmentRunArn - The ARN that specifies the assessment run whose agents you want to list.

Request Lenses

listAssessmentRunAgents_nextToken :: Lens' ListAssessmentRunAgents (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 ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listAssessmentRunAgents_filter :: Lens' ListAssessmentRunAgents (Maybe AgentFilter) Source #

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

listAssessmentRunAgents_maxResults :: Lens' ListAssessmentRunAgents (Maybe Int) Source #

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

listAssessmentRunAgents_assessmentRunArn :: Lens' ListAssessmentRunAgents Text Source #

The ARN that specifies the assessment run whose agents you want to list.

Destructuring the Response

data ListAssessmentRunAgentsResponse Source #

See: newListAssessmentRunAgentsResponse smart constructor.

Constructors

ListAssessmentRunAgentsResponse' 

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.

  • assessmentRunAgents :: [AssessmentRunAgent]

    A list of ARNs that specifies the agents returned by the action.

Instances

Instances details
Eq ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Read ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Show ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Generic ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

Associated Types

type Rep ListAssessmentRunAgentsResponse :: Type -> Type #

NFData ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

type Rep ListAssessmentRunAgentsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListAssessmentRunAgents

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

newListAssessmentRunAgentsResponse Source #

Create a value of ListAssessmentRunAgentsResponse 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:ListAssessmentRunAgents', listAssessmentRunAgentsResponse_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:ListAssessmentRunAgentsResponse', listAssessmentRunAgentsResponse_httpStatus - The response's http status code.

$sel:assessmentRunAgents:ListAssessmentRunAgentsResponse', listAssessmentRunAgentsResponse_assessmentRunAgents - A list of ARNs that specifies the agents returned by the action.

Response Lenses

listAssessmentRunAgentsResponse_nextToken :: Lens' ListAssessmentRunAgentsResponse (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.