libZSservicesZSamazonka-chimeZSamazonka-chime
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.Chime.ListChannelMemberships

Description

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Synopsis

Creating a Request

data ListChannelMemberships Source #

See: newListChannelMemberships smart constructor.

Constructors

ListChannelMemberships' 

Fields

  • chimeBearer :: Maybe Text

    The AppInstanceUserArn of the user that makes the API call.

  • nextToken :: Maybe (Sensitive Text)

    The token passed by previous API calls until all requested channel memberships are returned.

  • type' :: Maybe ChannelMembershipType

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

  • maxResults :: Maybe Natural

    The maximum number of channel memberships that you want returned.

  • channelArn :: Text

    The maximum number of channel memberships that you want returned.

Instances

Instances details
Eq ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Show ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Generic ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type Rep ListChannelMemberships :: Type -> Type #

NFData ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Methods

rnf :: ListChannelMemberships -> () #

Hashable ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

AWSRequest ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type AWSResponse ListChannelMemberships #

ToHeaders ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

ToPath ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

ToQuery ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

type Rep ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

type Rep ListChannelMemberships = D1 ('MetaData "ListChannelMemberships" "Amazonka.Chime.ListChannelMemberships" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "ListChannelMemberships'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMembershipType)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListChannelMemberships Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

newListChannelMemberships Source #

Create a value of ListChannelMemberships 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:chimeBearer:ListChannelMemberships', listChannelMemberships_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

$sel:nextToken:ListChannelMemberships', listChannelMemberships_nextToken - The token passed by previous API calls until all requested channel memberships are returned.

$sel:type':ListChannelMemberships', listChannelMemberships_type - The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

$sel:maxResults:ListChannelMemberships', listChannelMemberships_maxResults - The maximum number of channel memberships that you want returned.

$sel:channelArn:ListChannelMemberships', listChannelMemberships_channelArn - The maximum number of channel memberships that you want returned.

Request Lenses

listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text) Source #

The token passed by previous API calls until all requested channel memberships are returned.

listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType) Source #

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural) Source #

The maximum number of channel memberships that you want returned.

listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text Source #

The maximum number of channel memberships that you want returned.

Destructuring the Response

data ListChannelMembershipsResponse Source #

See: newListChannelMembershipsResponse smart constructor.

Constructors

ListChannelMembershipsResponse' 

Fields

Instances

Instances details
Eq ListChannelMembershipsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Show ListChannelMembershipsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Generic ListChannelMembershipsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type Rep ListChannelMembershipsResponse :: Type -> Type #

NFData ListChannelMembershipsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

type Rep ListChannelMembershipsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMemberships

type Rep ListChannelMembershipsResponse = D1 ('MetaData "ListChannelMembershipsResponse" "Amazonka.Chime.ListChannelMemberships" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "ListChannelMembershipsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelMembershipSummary])) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelMembershipsResponse Source #

Create a value of ListChannelMembershipsResponse 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:channelMemberships:ListChannelMembershipsResponse', listChannelMembershipsResponse_channelMemberships - The information for the requested channel memberships.

$sel:channelArn:ListChannelMemberships', listChannelMembershipsResponse_channelArn - The ARN of the channel.

$sel:nextToken:ListChannelMemberships', listChannelMembershipsResponse_nextToken - The token passed by previous API calls until all requested channel memberships are returned.

$sel:httpStatus:ListChannelMembershipsResponse', listChannelMembershipsResponse_httpStatus - The response's http status code.

Response Lenses

listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #

The token passed by previous API calls until all requested channel memberships are returned.