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 |
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
Synopsis
- data DescribeThingGroup = DescribeThingGroup' {}
- newDescribeThingGroup :: Text -> DescribeThingGroup
- describeThingGroup_thingGroupName :: Lens' DescribeThingGroup Text
- data DescribeThingGroupResponse = DescribeThingGroupResponse' {
- status :: Maybe DynamicGroupStatus
- queryVersion :: Maybe Text
- thingGroupArn :: Maybe Text
- thingGroupId :: Maybe Text
- thingGroupMetadata :: Maybe ThingGroupMetadata
- thingGroupName :: Maybe Text
- queryString :: Maybe Text
- version :: Maybe Integer
- thingGroupProperties :: Maybe ThingGroupProperties
- indexName :: Maybe Text
- httpStatus :: Int
- newDescribeThingGroupResponse :: Int -> DescribeThingGroupResponse
- describeThingGroupResponse_status :: Lens' DescribeThingGroupResponse (Maybe DynamicGroupStatus)
- describeThingGroupResponse_queryVersion :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_thingGroupArn :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_thingGroupId :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_thingGroupMetadata :: Lens' DescribeThingGroupResponse (Maybe ThingGroupMetadata)
- describeThingGroupResponse_thingGroupName :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_queryString :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_version :: Lens' DescribeThingGroupResponse (Maybe Integer)
- describeThingGroupResponse_thingGroupProperties :: Lens' DescribeThingGroupResponse (Maybe ThingGroupProperties)
- describeThingGroupResponse_indexName :: Lens' DescribeThingGroupResponse (Maybe Text)
- describeThingGroupResponse_httpStatus :: Lens' DescribeThingGroupResponse Int
Creating a Request
data DescribeThingGroup Source #
See: newDescribeThingGroup
smart constructor.
DescribeThingGroup' | |
|
Instances
newDescribeThingGroup Source #
Create a value of DescribeThingGroup
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:thingGroupName:DescribeThingGroup'
, describeThingGroup_thingGroupName
- The name of the thing group.
Request Lenses
describeThingGroup_thingGroupName :: Lens' DescribeThingGroup Text Source #
The name of the thing group.
Destructuring the Response
data DescribeThingGroupResponse Source #
See: newDescribeThingGroupResponse
smart constructor.
DescribeThingGroupResponse' | |
|
Instances
newDescribeThingGroupResponse Source #
Create a value of DescribeThingGroupResponse
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:status:DescribeThingGroupResponse'
, describeThingGroupResponse_status
- The dynamic thing group status.
$sel:queryVersion:DescribeThingGroupResponse'
, describeThingGroupResponse_queryVersion
- The dynamic thing group query version.
$sel:thingGroupArn:DescribeThingGroupResponse'
, describeThingGroupResponse_thingGroupArn
- The thing group ARN.
$sel:thingGroupId:DescribeThingGroupResponse'
, describeThingGroupResponse_thingGroupId
- The thing group ID.
$sel:thingGroupMetadata:DescribeThingGroupResponse'
, describeThingGroupResponse_thingGroupMetadata
- Thing group metadata.
$sel:thingGroupName:DescribeThingGroup'
, describeThingGroupResponse_thingGroupName
- The name of the thing group.
$sel:queryString:DescribeThingGroupResponse'
, describeThingGroupResponse_queryString
- The dynamic thing group search query string.
$sel:version:DescribeThingGroupResponse'
, describeThingGroupResponse_version
- The version of the thing group.
$sel:thingGroupProperties:DescribeThingGroupResponse'
, describeThingGroupResponse_thingGroupProperties
- The thing group properties.
$sel:indexName:DescribeThingGroupResponse'
, describeThingGroupResponse_indexName
- The dynamic thing group index name.
$sel:httpStatus:DescribeThingGroupResponse'
, describeThingGroupResponse_httpStatus
- The response's http status code.
Response Lenses
describeThingGroupResponse_status :: Lens' DescribeThingGroupResponse (Maybe DynamicGroupStatus) Source #
The dynamic thing group status.
describeThingGroupResponse_queryVersion :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The dynamic thing group query version.
describeThingGroupResponse_thingGroupArn :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The thing group ARN.
describeThingGroupResponse_thingGroupId :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The thing group ID.
describeThingGroupResponse_thingGroupMetadata :: Lens' DescribeThingGroupResponse (Maybe ThingGroupMetadata) Source #
Thing group metadata.
describeThingGroupResponse_thingGroupName :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The name of the thing group.
describeThingGroupResponse_queryString :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The dynamic thing group search query string.
describeThingGroupResponse_version :: Lens' DescribeThingGroupResponse (Maybe Integer) Source #
The version of the thing group.
describeThingGroupResponse_thingGroupProperties :: Lens' DescribeThingGroupResponse (Maybe ThingGroupProperties) Source #
The thing group properties.
describeThingGroupResponse_indexName :: Lens' DescribeThingGroupResponse (Maybe Text) Source #
The dynamic thing group index name.
describeThingGroupResponse_httpStatus :: Lens' DescribeThingGroupResponse Int Source #
The response's http status code.