libZSservicesZSamazonka-fmsZSamazonka-fms
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.FMS.ListMemberAccounts

Description

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.

The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMemberAccounts Source #

See: newListMemberAccounts smart constructor.

Constructors

ListMemberAccounts' 

Fields

  • nextToken :: Maybe Text

    If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

  • maxResults :: Maybe Natural

    Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

Instances

Instances details
Eq ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Read ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Show ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Generic ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Associated Types

type Rep ListMemberAccounts :: Type -> Type #

NFData ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Methods

rnf :: ListMemberAccounts -> () #

Hashable ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

ToJSON ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

AWSPager ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

AWSRequest ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Associated Types

type AWSResponse ListMemberAccounts #

ToHeaders ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

ToPath ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

ToQuery ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

type Rep ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

type Rep ListMemberAccounts = D1 ('MetaData "ListMemberAccounts" "Amazonka.FMS.ListMemberAccounts" "libZSservicesZSamazonka-fmsZSamazonka-fms" 'False) (C1 ('MetaCons "ListMemberAccounts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListMemberAccounts Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

newListMemberAccounts :: ListMemberAccounts Source #

Create a value of ListMemberAccounts 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:nextToken:ListMemberAccounts', listMemberAccounts_nextToken - If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

$sel:maxResults:ListMemberAccounts', listMemberAccounts_maxResults - Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

Request Lenses

listMemberAccounts_nextToken :: Lens' ListMemberAccounts (Maybe Text) Source #

If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

listMemberAccounts_maxResults :: Lens' ListMemberAccounts (Maybe Natural) Source #

Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

Destructuring the Response

data ListMemberAccountsResponse Source #

See: newListMemberAccountsResponse smart constructor.

Constructors

ListMemberAccountsResponse' 

Fields

  • nextToken :: Maybe Text

    If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

  • memberAccounts :: Maybe [Text]

    An array of account IDs.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Read ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Show ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Generic ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

Associated Types

type Rep ListMemberAccountsResponse :: Type -> Type #

NFData ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

type Rep ListMemberAccountsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListMemberAccounts

type Rep ListMemberAccountsResponse = D1 ('MetaData "ListMemberAccountsResponse" "Amazonka.FMS.ListMemberAccounts" "libZSservicesZSamazonka-fmsZSamazonka-fms" 'False) (C1 ('MetaCons "ListMemberAccountsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "memberAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMemberAccountsResponse Source #

Create a value of ListMemberAccountsResponse 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:nextToken:ListMemberAccounts', listMemberAccountsResponse_nextToken - If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

$sel:memberAccounts:ListMemberAccountsResponse', listMemberAccountsResponse_memberAccounts - An array of account IDs.

$sel:httpStatus:ListMemberAccountsResponse', listMemberAccountsResponse_httpStatus - The response's http status code.

Response Lenses

listMemberAccountsResponse_nextToken :: Lens' ListMemberAccountsResponse (Maybe Text) Source #

If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.