| 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.IoT.ListThings
Description
Lists your things. Use the attributeName and attributeValue
parameters to filter your things. For example, calling ListThings with
attributeName=Color and attributeValue=Red retrieves all things in the
registry that contain an attribute Color with the value Red. For
more information, see
List Things
from the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You will not be charged for calling this API if an Access denied error
is returned. You will also not be charged if no attributes or pagination
token was provided in request and no pagination token and no results
were returned.
This operation returns paginated results.
Synopsis
- data ListThings = ListThings' {}
- newListThings :: ListThings
- listThings_attributeName :: Lens' ListThings (Maybe Text)
- listThings_attributeValue :: Lens' ListThings (Maybe Text)
- listThings_maxResults :: Lens' ListThings (Maybe Natural)
- listThings_nextToken :: Lens' ListThings (Maybe Text)
- listThings_thingTypeName :: Lens' ListThings (Maybe Text)
- listThings_usePrefixAttributeValue :: Lens' ListThings (Maybe Bool)
- data ListThingsResponse = ListThingsResponse' {
- nextToken :: Maybe Text
- things :: Maybe [ThingAttribute]
- httpStatus :: Int
- newListThingsResponse :: Int -> ListThingsResponse
- listThingsResponse_nextToken :: Lens' ListThingsResponse (Maybe Text)
- listThingsResponse_things :: Lens' ListThingsResponse (Maybe [ThingAttribute])
- listThingsResponse_httpStatus :: Lens' ListThingsResponse Int
Creating a Request
data ListThings Source #
The input for the ListThings operation.
See: newListThings smart constructor.
Constructors
| ListThings' | |
Fields
| |
Instances
newListThings :: ListThings Source #
Create a value of ListThings 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:attributeName:ListThings', listThings_attributeName - The attribute name used to search for things.
$sel:attributeValue:ListThings', listThings_attributeValue - The attribute value used to search for things.
$sel:maxResults:ListThings', listThings_maxResults - The maximum number of results to return in this operation.
ListThings, listThings_nextToken - To retrieve the next set of results, the nextToken value from a
previous response; otherwise null to receive the first set of
results.
ListThings, listThings_thingTypeName - The name of the thing type used to search for things.
$sel:usePrefixAttributeValue:ListThings', listThings_usePrefixAttributeValue - When true, the action returns the thing resources with attribute
values that start with the attributeValue provided.
When false, or not present, the action returns only the thing
resources with attribute values that match the entire attributeValue
provided.
Request Lenses
listThings_attributeName :: Lens' ListThings (Maybe Text) Source #
The attribute name used to search for things.
listThings_attributeValue :: Lens' ListThings (Maybe Text) Source #
The attribute value used to search for things.
listThings_maxResults :: Lens' ListThings (Maybe Natural) Source #
The maximum number of results to return in this operation.
listThings_nextToken :: Lens' ListThings (Maybe Text) Source #
To retrieve the next set of results, the nextToken value from a
previous response; otherwise null to receive the first set of
results.
listThings_thingTypeName :: Lens' ListThings (Maybe Text) Source #
The name of the thing type used to search for things.
listThings_usePrefixAttributeValue :: Lens' ListThings (Maybe Bool) Source #
When true, the action returns the thing resources with attribute
values that start with the attributeValue provided.
When false, or not present, the action returns only the thing
resources with attribute values that match the entire attributeValue
provided.
Destructuring the Response
data ListThingsResponse Source #
The output from the ListThings operation.
See: newListThingsResponse smart constructor.
Constructors
| ListThingsResponse' | |
Fields
| |
Instances
newListThingsResponse Source #
Arguments
| :: Int | |
| -> ListThingsResponse |
Create a value of ListThingsResponse 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:
ListThings, listThingsResponse_nextToken - The token to use to get the next set of results. Will not be returned if
operation has returned all results.
$sel:things:ListThingsResponse', listThingsResponse_things - The things.
$sel:httpStatus:ListThingsResponse', listThingsResponse_httpStatus - The response's http status code.
Response Lenses
listThingsResponse_nextToken :: Lens' ListThingsResponse (Maybe Text) Source #
The token to use to get the next set of results. Will not be returned if operation has returned all results.
listThingsResponse_things :: Lens' ListThingsResponse (Maybe [ThingAttribute]) Source #
The things.
listThingsResponse_httpStatus :: Lens' ListThingsResponse Int Source #
The response's http status code.