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.WorkMail.ListMailboxPermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the mailbox permissions associated with a user, group, or resource mailbox.

This operation returns paginated results.

Synopsis

data ListMailboxPermissions = ListMailboxPermissions' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- organizationId :: Text
- entityId :: Text
}
newListMailboxPermissions :: Text -> Text -> ListMailboxPermissions
listMailboxPermissions_nextToken :: Lens' ListMailboxPermissions (Maybe Text)
listMailboxPermissions_maxResults :: Lens' ListMailboxPermissions (Maybe Natural)
listMailboxPermissions_organizationId :: Lens' ListMailboxPermissions Text
listMailboxPermissions_entityId :: Lens' ListMailboxPermissions Text
data ListMailboxPermissionsResponse = ListMailboxPermissionsResponse' {
- nextToken :: Maybe Text
- permissions :: Maybe [Permission]
- httpStatus :: Int
}
newListMailboxPermissionsResponse :: Int -> ListMailboxPermissionsResponse
listMailboxPermissionsResponse_nextToken :: Lens' ListMailboxPermissionsResponse (Maybe Text)
listMailboxPermissionsResponse_permissions :: Lens' ListMailboxPermissionsResponse (Maybe [Permission])
listMailboxPermissionsResponse_httpStatus :: Lens' ListMailboxPermissionsResponse Int

Creating a Request

data ListMailboxPermissions Source #

See: newListMailboxPermissions smart constructor.

Constructors

ListMailboxPermissions'

Fields

nextToken :: Maybe Text
The token to use to retrieve the next page of results. The first call does not contain any tokens.
maxResults :: Maybe Natural
The maximum number of results to return in a single call.
organizationId :: Text
The identifier of the organization under which the user, group, or resource exists.
entityId :: Text
The identifier of the user, group, or resource for which to list mailbox permissions.

Instances

Instances details

Eq ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods (==) :: ListMailboxPermissions -> ListMailboxPermissions -> Bool # (/=) :: ListMailboxPermissions -> ListMailboxPermissions -> Bool #
Read ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods readsPrec :: Int -> ReadS ListMailboxPermissions # readList :: ReadS [ListMailboxPermissions] # readPrec :: ReadPrec ListMailboxPermissions # readListPrec :: ReadPrec [ListMailboxPermissions] #
Show ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods showsPrec :: Int -> ListMailboxPermissions -> ShowS # show :: ListMailboxPermissions -> String # showList :: [ListMailboxPermissions] -> ShowS #
Generic ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Associated Types type Rep ListMailboxPermissions :: Type -> Type # Methods from :: ListMailboxPermissions -> Rep ListMailboxPermissions x # to :: Rep ListMailboxPermissions x -> ListMailboxPermissions #
NFData ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods rnf :: ListMailboxPermissions -> () #
Hashable ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods hashWithSalt :: Int -> ListMailboxPermissions -> Int # hash :: ListMailboxPermissions -> Int #
ToJSON ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods toJSON :: ListMailboxPermissions -> Value # toEncoding :: ListMailboxPermissions -> Encoding # toJSONList :: [ListMailboxPermissions] -> Value # toEncodingList :: [ListMailboxPermissions] -> Encoding #
AWSPager ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods page :: ListMailboxPermissions -> AWSResponse ListMailboxPermissions -> Maybe ListMailboxPermissions #
AWSRequest ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Associated Types type AWSResponse ListMailboxPermissions # Methods request :: ListMailboxPermissions -> Request ListMailboxPermissions # response :: MonadResource m => Logger -> Service -> Proxy ListMailboxPermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMailboxPermissions))) #
ToHeaders ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods toHeaders :: ListMailboxPermissions -> [Header] #
ToPath ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods toPath :: ListMailboxPermissions -> ByteString #
ToQuery ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods toQuery :: ListMailboxPermissions -> QueryString #
type Rep ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions type Rep ListMailboxPermissions = D1 ('MetaData "ListMailboxPermissions" "Amazonka.WorkMail.ListMailboxPermissions" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListMailboxPermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListMailboxPermissions Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions type AWSResponse ListMailboxPermissions = ListMailboxPermissionsResponse

newListMailboxPermissions Source #

Arguments

:: Text	`$sel:organizationId:ListMailboxPermissions'`
-> Text	`$sel:entityId:ListMailboxPermissions'`
-> ListMailboxPermissions

Create a value of ListMailboxPermissions 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:ListMailboxPermissions', listMailboxPermissions_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

$sel:maxResults:ListMailboxPermissions', listMailboxPermissions_maxResults - The maximum number of results to return in a single call.

$sel:organizationId:ListMailboxPermissions', listMailboxPermissions_organizationId - The identifier of the organization under which the user, group, or resource exists.

$sel:entityId:ListMailboxPermissions', listMailboxPermissions_entityId - The identifier of the user, group, or resource for which to list mailbox permissions.

Request Lenses

listMailboxPermissions_nextToken :: Lens' ListMailboxPermissions (Maybe Text) Source #

The token to use to retrieve the next page of results. The first call does not contain any tokens.

listMailboxPermissions_maxResults :: Lens' ListMailboxPermissions (Maybe Natural) Source #

The maximum number of results to return in a single call.

listMailboxPermissions_organizationId :: Lens' ListMailboxPermissions Text Source #

The identifier of the organization under which the user, group, or resource exists.

listMailboxPermissions_entityId :: Lens' ListMailboxPermissions Text Source #

The identifier of the user, group, or resource for which to list mailbox permissions.

Destructuring the Response

data ListMailboxPermissionsResponse Source #

See: newListMailboxPermissionsResponse smart constructor.

Constructors

ListMailboxPermissionsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. permissions :: Maybe [Permission] One page of the user, group, or resource mailbox permissions. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods (==) :: ListMailboxPermissionsResponse -> ListMailboxPermissionsResponse -> Bool # (/=) :: ListMailboxPermissionsResponse -> ListMailboxPermissionsResponse -> Bool #
Read ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods readsPrec :: Int -> ReadS ListMailboxPermissionsResponse # readList :: ReadS [ListMailboxPermissionsResponse] # readPrec :: ReadPrec ListMailboxPermissionsResponse # readListPrec :: ReadPrec [ListMailboxPermissionsResponse] #
Show ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods showsPrec :: Int -> ListMailboxPermissionsResponse -> ShowS # show :: ListMailboxPermissionsResponse -> String # showList :: [ListMailboxPermissionsResponse] -> ShowS #
Generic ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Associated Types type Rep ListMailboxPermissionsResponse :: Type -> Type # Methods from :: ListMailboxPermissionsResponse -> Rep ListMailboxPermissionsResponse x # to :: Rep ListMailboxPermissionsResponse x -> ListMailboxPermissionsResponse #
NFData ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions Methods rnf :: ListMailboxPermissionsResponse -> () #
type Rep ListMailboxPermissionsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailboxPermissions type Rep ListMailboxPermissionsResponse = D1 ('MetaData "ListMailboxPermissionsResponse" "Amazonka.WorkMail.ListMailboxPermissions" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListMailboxPermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Permission])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMailboxPermissionsResponse Source #

Arguments

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

Create a value of ListMailboxPermissionsResponse 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:ListMailboxPermissions', listMailboxPermissionsResponse_nextToken - The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

$sel:permissions:ListMailboxPermissionsResponse', listMailboxPermissionsResponse_permissions - One page of the user, group, or resource mailbox permissions.

$sel:httpStatus:ListMailboxPermissionsResponse', listMailboxPermissionsResponse_httpStatus - The response's http status code.

Response Lenses

listMailboxPermissionsResponse_nextToken :: Lens' ListMailboxPermissionsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

listMailboxPermissionsResponse_permissions :: Lens' ListMailboxPermissionsResponse (Maybe [Permission]) Source #

One page of the user, group, or resource mailbox permissions.

listMailboxPermissionsResponse_httpStatus :: Lens' ListMailboxPermissionsResponse Int Source #

The response's http status code.