| 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.IotTwinMaker.ListEntities
Description
Lists all entities in a workspace.
Synopsis
- data ListEntities = ListEntities' {}
- newListEntities :: Text -> ListEntities
- listEntities_filters :: Lens' ListEntities (Maybe [ListEntitiesFilter])
- listEntities_maxResults :: Lens' ListEntities (Maybe Natural)
- listEntities_nextToken :: Lens' ListEntities (Maybe Text)
- listEntities_workspaceId :: Lens' ListEntities Text
- data ListEntitiesResponse = ListEntitiesResponse' {
- entitySummaries :: Maybe [EntitySummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListEntitiesResponse :: Int -> ListEntitiesResponse
- listEntitiesResponse_entitySummaries :: Lens' ListEntitiesResponse (Maybe [EntitySummary])
- listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text)
- listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int
Creating a Request
data ListEntities Source #
See: newListEntities smart constructor.
Constructors
| ListEntities' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListEntities |
Create a value of ListEntities 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:filters:ListEntities', listEntities_filters - A list of objects that filter the request.
Only one object is accepted as a valid input.
$sel:maxResults:ListEntities', listEntities_maxResults - The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ListEntities, listEntities_nextToken - The string that specifies the next page of results.
ListEntities, listEntities_workspaceId - The ID of the workspace.
Request Lenses
listEntities_filters :: Lens' ListEntities (Maybe [ListEntitiesFilter]) Source #
A list of objects that filter the request.
Only one object is accepted as a valid input.
listEntities_maxResults :: Lens' ListEntities (Maybe Natural) Source #
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
listEntities_nextToken :: Lens' ListEntities (Maybe Text) Source #
The string that specifies the next page of results.
listEntities_workspaceId :: Lens' ListEntities Text Source #
The ID of the workspace.
Destructuring the Response
data ListEntitiesResponse Source #
See: newListEntitiesResponse smart constructor.
Constructors
| ListEntitiesResponse' | |
Fields
| |
Instances
newListEntitiesResponse Source #
Arguments
| :: Int | |
| -> ListEntitiesResponse |
Create a value of ListEntitiesResponse 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:entitySummaries:ListEntitiesResponse', listEntitiesResponse_entitySummaries - A list of objects that contain information about the entities.
ListEntities, listEntitiesResponse_nextToken - The string that specifies the next page of results.
$sel:httpStatus:ListEntitiesResponse', listEntitiesResponse_httpStatus - The response's http status code.
Response Lenses
listEntitiesResponse_entitySummaries :: Lens' ListEntitiesResponse (Maybe [EntitySummary]) Source #
A list of objects that contain information about the entities.
listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text) Source #
The string that specifies the next page of results.
listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int Source #
The response's http status code.