libZSservicesZSamazonka-securityhubZSamazonka-securityhub
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.SecurityHub.ListMembers

Description

Lists details about all member accounts for the current Security Hub administrator account.

The results include both member accounts that belong to an organization and member accounts that were invited manually.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMembers Source #

See: newListMembers smart constructor.

Constructors

ListMembers' 

Fields

  • onlyAssociated :: Maybe Bool

    Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

    If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

    If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

  • nextToken :: Maybe Text

    The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • maxResults :: Maybe Natural

    The maximum number of items to return in the response.

Instances

Instances details
Eq ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

(==) :: ListMembers -> ListMembers -> Bool #

(/=) :: ListMembers -> ListMembers -> Bool #

Read ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

readsPrec :: Int -> ReadS ListMembers #

readList :: ReadS [ListMembers] #

readPrec :: ReadPrec ListMembers #

readListPrec :: ReadPrec [ListMembers] #

Show ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

showsPrec :: Int -> ListMembers -> ShowS #

show :: ListMembers -> String #

showList :: [ListMembers] -> ShowS #

Generic ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Associated Types

type Rep ListMembers :: Type -> Type #

Methods

from :: ListMembers -> Rep ListMembers x #

to :: Rep ListMembers x -> ListMembers #

NFData ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

rnf :: ListMembers -> () #

Hashable ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

hashWithSalt :: Int -> ListMembers -> Int #

hash :: ListMembers -> Int #

AWSPager ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

page :: ListMembers -> AWSResponse ListMembers -> Maybe ListMembers #

AWSRequest ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Associated Types

type AWSResponse ListMembers #

Methods

request :: ListMembers -> Request ListMembers #

response :: MonadResource m => Logger -> Service -> Proxy ListMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMembers))) #

ToHeaders ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

toHeaders :: ListMembers -> [Header] #

ToPath ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

toPath :: ListMembers -> ByteString #

ToQuery ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

toQuery :: ListMembers -> QueryString #

type Rep ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

type Rep ListMembers = D1 ('MetaData "ListMembers" "Amazonka.SecurityHub.ListMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "ListMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onlyAssociated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

type AWSResponse ListMembers = ListMembersResponse

newListMembers :: ListMembers Source #

Create a value of ListMembers 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:onlyAssociated:ListMembers', listMembers_onlyAssociated - Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

$sel:nextToken:ListMembers', listMembers_nextToken - The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

$sel:maxResults:ListMembers', listMembers_maxResults - The maximum number of items to return in the response.

Request Lenses

listMembers_onlyAssociated :: Lens' ListMembers (Maybe Bool) Source #

Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #

The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #

The maximum number of items to return in the response.

Destructuring the Response

data ListMembersResponse Source #

See: newListMembersResponse smart constructor.

Constructors

ListMembersResponse' 

Fields

Instances

Instances details
Eq ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

(==) :: ListMembersResponse -> ListMembersResponse -> Bool #

(/=) :: ListMembersResponse -> ListMembersResponse -> Bool #

Read ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

readsPrec :: Int -> ReadS ListMembersResponse #

readList :: ReadS [ListMembersResponse] #

readPrec :: ReadPrec ListMembersResponse #

readListPrec :: ReadPrec [ListMembersResponse] #

Show ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

showsPrec :: Int -> ListMembersResponse -> ShowS #

show :: ListMembersResponse -> String #

showList :: [ListMembersResponse] -> ShowS #

Generic ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Associated Types

type Rep ListMembersResponse :: Type -> Type #

Methods

from :: ListMembersResponse -> Rep ListMembersResponse x #

to :: Rep ListMembersResponse x -> ListMembersResponse #

NFData ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

Methods

rnf :: ListMembersResponse -> () #

type Rep ListMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.ListMembers

type Rep ListMembersResponse = D1 ('MetaData "ListMembersResponse" "Amazonka.SecurityHub.ListMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "ListMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Member])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMembersResponse Source #

Arguments

:: Int

$sel:httpStatus:ListMembersResponse'

-> ListMembersResponse 

Create a value of ListMembersResponse 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:members:ListMembersResponse', listMembersResponse_members - Member details returned by the operation.

$sel:nextToken:ListMembers', listMembersResponse_nextToken - The pagination token to use to request the next page of results.

$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.

Response Lenses

listMembersResponse_members :: Lens' ListMembersResponse (Maybe [Member]) Source #

Member details returned by the operation.

listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #

The pagination token to use to request the next page of results.

listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #

The response's http status code.