amazonka-detective-2.0: Amazon Detective SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Detective.ListGraphs

Description

Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.

Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.

Synopsis

Creating a Request

data ListGraphs Source #

See: newListGraphs smart constructor.

Constructors

ListGraphs' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

  • nextToken :: Maybe Text

    For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

Instances

Instances details
ToJSON ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

ToHeaders ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Methods

toHeaders :: ListGraphs -> [Header] #

ToPath ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

ToQuery ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

AWSRequest ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Associated Types

type AWSResponse ListGraphs #

Generic ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Associated Types

type Rep ListGraphs :: Type -> Type #

Read ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Show ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

NFData ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Methods

rnf :: ListGraphs -> () #

Eq ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Hashable ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

type AWSResponse ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

type Rep ListGraphs Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

type Rep ListGraphs = D1 ('MetaData "ListGraphs" "Amazonka.Detective.ListGraphs" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "ListGraphs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListGraphs :: ListGraphs Source #

Create a value of ListGraphs 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:maxResults:ListGraphs', listGraphs_maxResults - The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

ListGraphs, listGraphs_nextToken - For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

Request Lenses

listGraphs_maxResults :: Lens' ListGraphs (Maybe Natural) Source #

The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

listGraphs_nextToken :: Lens' ListGraphs (Maybe Text) Source #

For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

Destructuring the Response

data ListGraphsResponse Source #

See: newListGraphsResponse smart constructor.

Constructors

ListGraphsResponse' 

Fields

  • graphList :: Maybe [Graph]

    A list of behavior graphs that the account is an administrator account for.

  • nextToken :: Maybe Text

    If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Associated Types

type Rep ListGraphsResponse :: Type -> Type #

Read ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Show ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

NFData ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

Methods

rnf :: ListGraphsResponse -> () #

Eq ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

type Rep ListGraphsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListGraphs

type Rep ListGraphsResponse = D1 ('MetaData "ListGraphsResponse" "Amazonka.Detective.ListGraphs" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "ListGraphsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Graph])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGraphsResponse Source #

Create a value of ListGraphsResponse 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:graphList:ListGraphsResponse', listGraphsResponse_graphList - A list of behavior graphs that the account is an administrator account for.

ListGraphs, listGraphsResponse_nextToken - If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.

$sel:httpStatus:ListGraphsResponse', listGraphsResponse_httpStatus - The response's http status code.

Response Lenses

listGraphsResponse_graphList :: Lens' ListGraphsResponse (Maybe [Graph]) Source #

A list of behavior graphs that the account is an administrator account for.

listGraphsResponse_nextToken :: Lens' ListGraphsResponse (Maybe Text) Source #

If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.