Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ChimeSDKMessaging.ListChannelMemberships

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

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.
chimeBearer :: Text
The AppInstanceUserArn of the user that makes the API call.

Instances

Instances details

Eq ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods (==) :: ListChannelMemberships -> ListChannelMemberships -> Bool # (/=) :: ListChannelMemberships -> ListChannelMemberships -> Bool #
Show ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods showsPrec :: Int -> ListChannelMemberships -> ShowS # show :: ListChannelMemberships -> String # showList :: [ListChannelMemberships] -> ShowS #
Generic ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Associated Types type Rep ListChannelMemberships :: Type -> Type # Methods from :: ListChannelMemberships -> Rep ListChannelMemberships x # to :: Rep ListChannelMemberships x -> ListChannelMemberships #
NFData ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods rnf :: ListChannelMemberships -> () #
Hashable ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods hashWithSalt :: Int -> ListChannelMemberships -> Int # hash :: ListChannelMemberships -> Int #
AWSRequest ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Associated Types type AWSResponse ListChannelMemberships # Methods request :: ListChannelMemberships -> Request ListChannelMemberships # response :: MonadResource m => Logger -> Service -> Proxy ListChannelMemberships -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannelMemberships))) #
ToHeaders ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods toHeaders :: ListChannelMemberships -> [Header] #
ToPath ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods toPath :: ListChannelMemberships -> ByteString #
ToQuery ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods toQuery :: ListChannelMemberships -> QueryString #
type Rep ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships type Rep ListChannelMemberships = D1 ('MetaData "ListChannelMemberships" "Amazonka.ChimeSDKMessaging.ListChannelMemberships" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannelMemberships'" 'PrefixI 'True) ((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) :: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListChannelMemberships Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships type AWSResponse ListChannelMemberships = ListChannelMembershipsResponse

newListChannelMemberships Source #

Arguments

:: Text	`$sel:channelArn:ListChannelMemberships'`
-> Text	`$sel:chimeBearer:ListChannelMemberships'`
-> ListChannelMemberships

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: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.

$sel:chimeBearer:ListChannelMemberships', listChannelMemberships_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

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.

listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelMembershipsResponse Source #

See: newListChannelMembershipsResponse smart constructor.

Constructors

ListChannelMembershipsResponse'
Fields channelMemberships :: Maybe [ChannelMembershipSummary] The information for the requested channel memberships. channelArn :: Maybe Text The ARN of the channel. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested channel memberships are returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListChannelMembershipsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods (==) :: ListChannelMembershipsResponse -> ListChannelMembershipsResponse -> Bool # (/=) :: ListChannelMembershipsResponse -> ListChannelMembershipsResponse -> Bool #
Show ListChannelMembershipsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods showsPrec :: Int -> ListChannelMembershipsResponse -> ShowS # show :: ListChannelMembershipsResponse -> String # showList :: [ListChannelMembershipsResponse] -> ShowS #
Generic ListChannelMembershipsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Associated Types type Rep ListChannelMembershipsResponse :: Type -> Type # Methods from :: ListChannelMembershipsResponse -> Rep ListChannelMembershipsResponse x # to :: Rep ListChannelMembershipsResponse x -> ListChannelMembershipsResponse #
NFData ListChannelMembershipsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships Methods rnf :: ListChannelMembershipsResponse -> () #
type Rep ListChannelMembershipsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMemberships type Rep ListChannelMembershipsResponse = D1 ('MetaData "ListChannelMembershipsResponse" "Amazonka.ChimeSDKMessaging.ListChannelMemberships" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" '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 #

Arguments

:: Int	`$sel:httpStatus:ListChannelMembershipsResponse'`
-> ListChannelMembershipsResponse

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_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary]) Source #

The information for the requested channel memberships.

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

The ARN of the channel.

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

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

listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int Source #

The response's http status code.