| 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.ListResources
Description
Returns summaries of the organization's resources.
This operation returns paginated results.
Synopsis
- data ListResources = ListResources' {}
- newListResources :: Text -> ListResources
- listResources_nextToken :: Lens' ListResources (Maybe Text)
- listResources_maxResults :: Lens' ListResources (Maybe Natural)
- listResources_organizationId :: Lens' ListResources Text
- data ListResourcesResponse = ListResourcesResponse' {}
- newListResourcesResponse :: Int -> ListResourcesResponse
- listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource])
- listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text)
- listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int
Creating a Request
data ListResources Source #
See: newListResources smart constructor.
Constructors
| ListResources' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListResources |
Create a value of ListResources 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:ListResources', listResources_nextToken - The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListResources', listResources_maxResults - The maximum number of results to return in a single call.
$sel:organizationId:ListResources', listResources_organizationId - The identifier for the organization under which the resources exist.
Request Lenses
listResources_nextToken :: Lens' ListResources (Maybe Text) Source #
The token to use to retrieve the next page of results. The first call does not contain any tokens.
listResources_maxResults :: Lens' ListResources (Maybe Natural) Source #
The maximum number of results to return in a single call.
listResources_organizationId :: Lens' ListResources Text Source #
The identifier for the organization under which the resources exist.
Destructuring the Response
data ListResourcesResponse Source #
See: newListResourcesResponse smart constructor.
Constructors
| ListResourcesResponse' | |
Fields
| |
Instances
newListResourcesResponse Source #
Create a value of ListResourcesResponse 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:resources:ListResourcesResponse', listResourcesResponse_resources - One page of the organization's resource representation.
$sel:nextToken:ListResources', listResourcesResponse_nextToken - The token used to paginate through all the organization's resources.
While results are still available, it has an associated value. When the
last page is reached, the token is empty.
$sel:httpStatus:ListResourcesResponse', listResourcesResponse_httpStatus - The response's http status code.
Response Lenses
listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource]) Source #
One page of the organization's resource representation.
listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text) Source #
The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #
The response's http status code.