Amazonka.Detective.GetMembers

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

Creating a Request

data GetMembers

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 Amazon Web Services 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

ToJSON GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

toJSON :: GetMembers -> Value

toEncoding :: GetMembers -> Encoding

toJSONList :: [GetMembers] -> Value

toEncodingList :: [GetMembers] -> Encoding

ToHeaders GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

toHeaders :: GetMembers -> [Header]

ToPath GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

toPath :: GetMembers -> ByteString

ToQuery GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

toQuery :: GetMembers -> QueryString

AWSRequest GetMembers

Defined in Amazonka.Detective.GetMembers

Associated Types

type AWSResponse GetMembers

Methods

request :: (Service -> Service) -> GetMembers -> Request GetMembers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMembers)))

Generic GetMembers

Defined in Amazonka.Detective.GetMembers

Associated Types

type Rep GetMembers :: Type -> Type

Methods

from :: GetMembers -> Rep GetMembers x

to :: Rep GetMembers x -> GetMembers

Read GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

readsPrec :: Int -> ReadS GetMembers

readList :: ReadS [GetMembers]

readPrec :: ReadPrec GetMembers

readListPrec :: ReadPrec [GetMembers]

Show GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

showsPrec :: Int -> GetMembers -> ShowS

show :: GetMembers -> String

showList :: [GetMembers] -> ShowS

NFData GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

rnf :: GetMembers -> ()

Eq GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

(==) :: GetMembers -> GetMembers -> Bool

(/=) :: GetMembers -> GetMembers -> Bool

Hashable GetMembers

Defined in Amazonka.Detective.GetMembers

Methods

hashWithSalt :: Int -> GetMembers -> Int

hash :: GetMembers -> Int

type AWSResponse GetMembers

Defined in Amazonka.Detective.GetMembers

type AWSResponse GetMembers = GetMembersResponse

type Rep GetMembers

Defined in Amazonka.Detective.GetMembers

type Rep GetMembers = D1 ('MetaData "GetMembers" "Amazonka.Detective.GetMembers" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" '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))))

newGetMembers

Arguments

:: Text

GetMembers

-> NonEmpty Text

$sel:accountIds:GetMembers'

-> GetMembers

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:

GetMembers, getMembers_graphArn - The ARN of the behavior graph for which to request the member details.

$sel:accountIds:GetMembers', getMembers_accountIds - The list of Amazon Web Services 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

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

getMembers_accountIds :: Lens' GetMembers (NonEmpty Text)

The list of Amazon Web Services 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

See: newGetMembersResponse smart constructor.

Constructors

GetMembersResponse'

Fields

• memberDetails :: Maybe [MemberDetail]

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

• unprocessedAccounts :: Maybe [UnprocessedAccount]

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetMembersResponse

Defined in Amazonka.Detective.GetMembers

Associated Types

type Rep GetMembersResponse :: Type -> Type

Methods

from :: GetMembersResponse -> Rep GetMembersResponse x

to :: Rep GetMembersResponse x -> GetMembersResponse

Read GetMembersResponse

Defined in Amazonka.Detective.GetMembers

Methods

readsPrec :: Int -> ReadS GetMembersResponse

readList :: ReadS [GetMembersResponse]

readPrec :: ReadPrec GetMembersResponse

readListPrec :: ReadPrec [GetMembersResponse]

Show GetMembersResponse

Defined in Amazonka.Detective.GetMembers

Methods

showsPrec :: Int -> GetMembersResponse -> ShowS

show :: GetMembersResponse -> String

showList :: [GetMembersResponse] -> ShowS

NFData GetMembersResponse

Defined in Amazonka.Detective.GetMembers

Methods

rnf :: GetMembersResponse -> ()

Eq GetMembersResponse

Defined in Amazonka.Detective.GetMembers

Methods

(==) :: GetMembersResponse -> GetMembersResponse -> Bool

(/=) :: GetMembersResponse -> GetMembersResponse -> Bool

type Rep GetMembersResponse

Defined in Amazonka.Detective.GetMembers

type Rep GetMembersResponse = D1 ('MetaData "GetMembersResponse" "Amazonka.Detective.GetMembers" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" '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

Arguments

:: Int

$sel:httpStatus:GetMembersResponse'

-> GetMembersResponse

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])

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

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

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.

getMembersResponse_httpStatus :: Lens' GetMembersResponse Int

The response's http status code.