Amazonka.Chime.ListChannelMemberships

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.

Creating a Request

data ListChannelMemberships

See: newListChannelMemberships smart constructor.

Constructors

ListChannelMemberships'

Fields

• chimeBearer :: Maybe Text

  The AppInstanceUserArn of the user that makes the API call.

• maxResults :: Maybe Natural

  The maximum number of channel memberships that you want returned.

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

• channelArn :: Text

  The maximum number of channel memberships that you want returned.

Instances

ToHeaders ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

toHeaders :: ListChannelMemberships -> [Header]

ToPath ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

toPath :: ListChannelMemberships -> ByteString

ToQuery ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

toQuery :: ListChannelMemberships -> QueryString

AWSRequest ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type AWSResponse ListChannelMemberships

Methods

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

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

Generic ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type Rep ListChannelMemberships :: Type -> Type

Methods

from :: ListChannelMemberships -> Rep ListChannelMemberships x

to :: Rep ListChannelMemberships x -> ListChannelMemberships

Show ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

showsPrec :: Int -> ListChannelMemberships -> ShowS

show :: ListChannelMemberships -> String

showList :: [ListChannelMemberships] -> ShowS

NFData ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

rnf :: ListChannelMemberships -> ()

Eq ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

(==) :: ListChannelMemberships -> ListChannelMemberships -> Bool

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

Hashable ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

Methods

hashWithSalt :: Int -> ListChannelMemberships -> Int

hash :: ListChannelMemberships -> Int

type AWSResponse ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

type AWSResponse ListChannelMemberships = ListChannelMembershipsResponse

type Rep ListChannelMemberships

Defined in Amazonka.Chime.ListChannelMemberships

type Rep ListChannelMemberships = D1 ('MetaData "ListChannelMemberships" "Amazonka.Chime.ListChannelMemberships" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListChannelMemberships'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMembershipType)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListChannelMemberships

Arguments

:: Text

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

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

ListChannelMemberships, listChannelMemberships_nextToken - The token passed by previous API calls until all requested channel memberships are returned.

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.

ListChannelMemberships, listChannelMemberships_channelArn - The maximum number of channel memberships that you want returned.

Request Lenses

listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships (Maybe Text)

The AppInstanceUserArn of the user that makes the API call.

listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural)

The maximum number of channel memberships that you want returned.

listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text)

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

listChannelMemberships_type :: Lens' ListChannelMemberships (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.

listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text

The maximum number of channel memberships that you want returned.

Destructuring the Response

data ListChannelMembershipsResponse

See: newListChannelMembershipsResponse smart constructor.

Constructors

ListChannelMembershipsResponse'

Fields

• channelArn :: Maybe Text

  The ARN of the channel.

• channelMemberships :: Maybe [ChannelMembershipSummary]

  The information for the requested channel memberships.

• 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

Generic ListChannelMembershipsResponse

Defined in Amazonka.Chime.ListChannelMemberships

Associated Types

type Rep ListChannelMembershipsResponse :: Type -> Type

Methods

from :: ListChannelMembershipsResponse -> Rep ListChannelMembershipsResponse x

to :: Rep ListChannelMembershipsResponse x -> ListChannelMembershipsResponse

Show ListChannelMembershipsResponse

Defined in Amazonka.Chime.ListChannelMemberships

Methods

showsPrec :: Int -> ListChannelMembershipsResponse -> ShowS

show :: ListChannelMembershipsResponse -> String

showList :: [ListChannelMembershipsResponse] -> ShowS

NFData ListChannelMembershipsResponse

Defined in Amazonka.Chime.ListChannelMemberships

Methods

rnf :: ListChannelMembershipsResponse -> ()

Eq ListChannelMembershipsResponse

Defined in Amazonka.Chime.ListChannelMemberships

Methods

(==) :: ListChannelMembershipsResponse -> ListChannelMembershipsResponse -> Bool

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

type Rep ListChannelMembershipsResponse

Defined in Amazonka.Chime.ListChannelMemberships

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

newListChannelMembershipsResponse

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:

ListChannelMemberships, listChannelMembershipsResponse_channelArn - The ARN of the channel.

$sel:channelMemberships:ListChannelMembershipsResponse', listChannelMembershipsResponse_channelMemberships - The information for the requested channel memberships.

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_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text)

The ARN of the channel.

listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary])

The information for the requested channel memberships.

listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text)

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

listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int

The response's http status code.