| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.WorkMail.ListMailboxPermissions
Description
Lists the mailbox permissions associated with a user, group, or resource mailbox.
This operation returns paginated results.
Synopsis
- data ListMailboxPermissions = ListMailboxPermissions' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- organizationId :: Text
- entityId :: Text
- newListMailboxPermissions :: Text -> Text -> ListMailboxPermissions
- listMailboxPermissions_maxResults :: Lens' ListMailboxPermissions (Maybe Natural)
- listMailboxPermissions_nextToken :: Lens' ListMailboxPermissions (Maybe Text)
- 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
| |
Instances
newListMailboxPermissions Source #
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:maxResults:ListMailboxPermissions', listMailboxPermissions_maxResults - The maximum number of results to return in a single call.
ListMailboxPermissions, listMailboxPermissions_nextToken - The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListMailboxPermissions, listMailboxPermissions_organizationId - The identifier of the organization under which the user, group, or
resource exists.
ListMailboxPermissions, listMailboxPermissions_entityId - The identifier of the user, group, or resource for which to list mailbox
permissions.
Request Lenses
listMailboxPermissions_maxResults :: Lens' ListMailboxPermissions (Maybe Natural) Source #
The maximum number of results to return in a single call.
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_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
| |
Instances
newListMailboxPermissionsResponse Source #
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:
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.