libZSservicesZSamazonka-detectiveZSamazonka-detective
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.Detective.GetMembers

Description

Returns the membership details for specified member accounts for a behavior graph.

Synopsis

Creating a Request

data GetMembers Source #

See: newGetMembers smart constructor.

Constructors

GetMembers' 

Fields

  • graphArn :: Text

    The ARN of the behavior graph for which to request the member details.

  • accountIds :: NonEmpty Text

    The list of AWS account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

    You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.

Instances

Instances details
Eq GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Read GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Show GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Generic GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Associated Types

type Rep GetMembers :: Type -> Type #

NFData GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Methods

rnf :: GetMembers -> () #

Hashable GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

ToJSON GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

AWSRequest GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Associated Types

type AWSResponse GetMembers #

ToHeaders GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Methods

toHeaders :: GetMembers -> [Header] #

ToPath GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

ToQuery GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

type Rep GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

type Rep GetMembers = D1 ('MetaData "GetMembers" "Amazonka.Detective.GetMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "GetMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))
type AWSResponse GetMembers Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

newGetMembers Source #

Create a value of GetMembers 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:graphArn:GetMembers', getMembers_graphArn - The ARN of the behavior graph for which to request the member details.

$sel:accountIds:GetMembers', getMembers_accountIds - The list of AWS account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.

Request Lenses

getMembers_graphArn :: Lens' GetMembers Text Source #

The ARN of the behavior graph for which to request the member details.

getMembers_accountIds :: Lens' GetMembers (NonEmpty Text) Source #

The list of AWS account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.

Destructuring the Response

data GetMembersResponse Source #

See: newGetMembersResponse smart constructor.

Constructors

GetMembersResponse' 

Fields

Instances

Instances details
Eq GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Read GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Show GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Generic GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Associated Types

type Rep GetMembersResponse :: Type -> Type #

NFData GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

Methods

rnf :: GetMembersResponse -> () #

type Rep GetMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.GetMembers

type Rep GetMembersResponse = D1 ('MetaData "GetMembersResponse" "Amazonka.Detective.GetMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "GetMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "memberDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MemberDetail])) :*: (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedAccount])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetMembersResponse Source #

Create a value of GetMembersResponse 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:memberDetails:GetMembersResponse', getMembersResponse_memberDetails - The member account details that Detective is returning in response to the request.

$sel:unprocessedAccounts:GetMembersResponse', getMembersResponse_unprocessedAccounts - The requested member accounts for which Detective was unable to return member details.

For each account, provides the reason why the request could not be processed.

$sel:httpStatus:GetMembersResponse', getMembersResponse_httpStatus - The response's http status code.

Response Lenses

getMembersResponse_memberDetails :: Lens' GetMembersResponse (Maybe [MemberDetail]) Source #

The member account details that Detective is returning in response to the request.

getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse (Maybe [UnprocessedAccount]) Source #

The requested member accounts for which Detective was unable to return member details.

For each account, provides the reason why the request could not be processed.