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

Description

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account.

Open invitations are invitations that the member account has not responded to.

The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

Synopsis

Creating a Request

data ListInvitations Source #

See: newListInvitations smart constructor.

Constructors

ListInvitations' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of behavior graph invitations to return in the response. 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 retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

Instances

Instances details
ToJSON ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

ToHeaders ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

ToPath ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

ToQuery ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

AWSRequest ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Associated Types

type AWSResponse ListInvitations #

Generic ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Associated Types

type Rep ListInvitations :: Type -> Type #

Read ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Show ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

NFData ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Methods

rnf :: ListInvitations -> () #

Eq ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Hashable ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

type AWSResponse ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

type Rep ListInvitations Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

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

newListInvitations :: ListInvitations Source #

Create a value of ListInvitations 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:ListInvitations', listInvitations_maxResults - The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

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

Request Lenses

listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural) Source #

The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

listInvitations_nextToken :: Lens' ListInvitations (Maybe Text) Source #

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

Destructuring the Response

data ListInvitationsResponse Source #

See: newListInvitationsResponse smart constructor.

Constructors

ListInvitationsResponse' 

Fields

  • invitations :: Maybe [MemberDetail]

    The list of behavior graphs for which the member account has open or accepted invitations.

  • 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 ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Associated Types

type Rep ListInvitationsResponse :: Type -> Type #

Read ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Show ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

NFData ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

Methods

rnf :: ListInvitationsResponse -> () #

Eq ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

type Rep ListInvitationsResponse Source # 
Instance details

Defined in Amazonka.Detective.ListInvitations

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

newListInvitationsResponse Source #

Create a value of ListInvitationsResponse 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:invitations:ListInvitationsResponse', listInvitationsResponse_invitations - The list of behavior graphs for which the member account has open or accepted invitations.

ListInvitations, listInvitationsResponse_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:ListInvitationsResponse', listInvitationsResponse_httpStatus - The response's http status code.

Response Lenses

listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [MemberDetail]) Source #

The list of behavior graphs for which the member account has open or accepted invitations.

listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (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.