Amazonka.IoT.DescribeThingGroup

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Creating a Request

data DescribeThingGroup

See: newDescribeThingGroup smart constructor.

Constructors

DescribeThingGroup'

Fields

• thingGroupName :: Text

  The name of the thing group.

Instances

ToHeaders DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

toHeaders :: DescribeThingGroup -> [Header]

ToPath DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

toPath :: DescribeThingGroup -> ByteString

ToQuery DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

toQuery :: DescribeThingGroup -> QueryString

AWSRequest DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Associated Types

type AWSResponse DescribeThingGroup

Methods

request :: (Service -> Service) -> DescribeThingGroup -> Request DescribeThingGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeThingGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeThingGroup)))

Generic DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Associated Types

type Rep DescribeThingGroup :: Type -> Type

Methods

from :: DescribeThingGroup -> Rep DescribeThingGroup x

to :: Rep DescribeThingGroup x -> DescribeThingGroup

Read DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

readsPrec :: Int -> ReadS DescribeThingGroup

readList :: ReadS [DescribeThingGroup]

readPrec :: ReadPrec DescribeThingGroup

readListPrec :: ReadPrec [DescribeThingGroup]

Show DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

showsPrec :: Int -> DescribeThingGroup -> ShowS

show :: DescribeThingGroup -> String

showList :: [DescribeThingGroup] -> ShowS

NFData DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

rnf :: DescribeThingGroup -> ()

Eq DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

(==) :: DescribeThingGroup -> DescribeThingGroup -> Bool

(/=) :: DescribeThingGroup -> DescribeThingGroup -> Bool

Hashable DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

Methods

hashWithSalt :: Int -> DescribeThingGroup -> Int

hash :: DescribeThingGroup -> Int

type AWSResponse DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

type AWSResponse DescribeThingGroup = DescribeThingGroupResponse

type Rep DescribeThingGroup

Defined in Amazonka.IoT.DescribeThingGroup

type Rep DescribeThingGroup = D1 ('MetaData "DescribeThingGroup" "Amazonka.IoT.DescribeThingGroup" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeThingGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeThingGroup

Arguments

:: Text

DescribeThingGroup

-> DescribeThingGroup

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:

DescribeThingGroup, describeThingGroup_thingGroupName - The name of the thing group.

Request Lenses

describeThingGroup_thingGroupName :: Lens' DescribeThingGroup Text

The name of the thing group.

Destructuring the Response

data DescribeThingGroupResponse

See: newDescribeThingGroupResponse smart constructor.

Constructors

DescribeThingGroupResponse'

Fields

• indexName :: Maybe Text

  The dynamic thing group index name.

• queryString :: Maybe Text

  The dynamic thing group search query string.

• queryVersion :: Maybe Text

  The dynamic thing group query version.

• status :: Maybe DynamicGroupStatus

  The dynamic thing group status.

• thingGroupArn :: Maybe Text

  The thing group ARN.

• thingGroupId :: Maybe Text

  The thing group ID.

• thingGroupMetadata :: Maybe ThingGroupMetadata

  Thing group metadata.

• thingGroupName :: Maybe Text

  The name of the thing group.

• thingGroupProperties :: Maybe ThingGroupProperties

  The thing group properties.

• version :: Maybe Integer

  The version of the thing group.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

Associated Types

type Rep DescribeThingGroupResponse :: Type -> Type

Methods

from :: DescribeThingGroupResponse -> Rep DescribeThingGroupResponse x

to :: Rep DescribeThingGroupResponse x -> DescribeThingGroupResponse

Read DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

Methods

readsPrec :: Int -> ReadS DescribeThingGroupResponse

readList :: ReadS [DescribeThingGroupResponse]

readPrec :: ReadPrec DescribeThingGroupResponse

readListPrec :: ReadPrec [DescribeThingGroupResponse]

Show DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

Methods

showsPrec :: Int -> DescribeThingGroupResponse -> ShowS

show :: DescribeThingGroupResponse -> String

showList :: [DescribeThingGroupResponse] -> ShowS

NFData DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

Methods

rnf :: DescribeThingGroupResponse -> ()

Eq DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

Methods

(==) :: DescribeThingGroupResponse -> DescribeThingGroupResponse -> Bool

(/=) :: DescribeThingGroupResponse -> DescribeThingGroupResponse -> Bool

type Rep DescribeThingGroupResponse

Defined in Amazonka.IoT.DescribeThingGroup

type Rep DescribeThingGroupResponse = D1 ('MetaData "DescribeThingGroupResponse" "Amazonka.IoT.DescribeThingGroup" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeThingGroupResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicGroupStatus)) :*: S1 ('MetaSel ('Just "thingGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "thingGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "thingGroupMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThingGroupMetadata)) :*: S1 ('MetaSel ('Just "thingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "thingGroupProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThingGroupProperties)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeThingGroupResponse

Arguments

:: Int

$sel:httpStatus:DescribeThingGroupResponse'

-> DescribeThingGroupResponse

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:indexName:DescribeThingGroupResponse', describeThingGroupResponse_indexName - The dynamic thing group index name.

DescribeThingGroupResponse, describeThingGroupResponse_queryString - The dynamic thing group search query string.

$sel:queryVersion:DescribeThingGroupResponse', describeThingGroupResponse_queryVersion - The dynamic thing group query version.

DescribeThingGroupResponse, describeThingGroupResponse_status - The dynamic thing group status.

$sel:thingGroupArn:DescribeThingGroupResponse', describeThingGroupResponse_thingGroupArn - The thing group ARN.

DescribeThingGroupResponse, describeThingGroupResponse_thingGroupId - The thing group ID.

$sel:thingGroupMetadata:DescribeThingGroupResponse', describeThingGroupResponse_thingGroupMetadata - Thing group metadata.

DescribeThingGroup, describeThingGroupResponse_thingGroupName - The name of the thing group.

$sel:thingGroupProperties:DescribeThingGroupResponse', describeThingGroupResponse_thingGroupProperties - The thing group properties.

DescribeThingGroupResponse, describeThingGroupResponse_version - The version of the thing group.

$sel:httpStatus:DescribeThingGroupResponse', describeThingGroupResponse_httpStatus - The response's http status code.

Response Lenses

describeThingGroupResponse_indexName :: Lens' DescribeThingGroupResponse (Maybe Text)

The dynamic thing group index name.

describeThingGroupResponse_queryString :: Lens' DescribeThingGroupResponse (Maybe Text)

The dynamic thing group search query string.

describeThingGroupResponse_queryVersion :: Lens' DescribeThingGroupResponse (Maybe Text)

The dynamic thing group query version.

describeThingGroupResponse_status :: Lens' DescribeThingGroupResponse (Maybe DynamicGroupStatus)

The dynamic thing group status.

describeThingGroupResponse_thingGroupArn :: Lens' DescribeThingGroupResponse (Maybe Text)

The thing group ARN.

describeThingGroupResponse_thingGroupId :: Lens' DescribeThingGroupResponse (Maybe Text)

The thing group ID.

describeThingGroupResponse_thingGroupMetadata :: Lens' DescribeThingGroupResponse (Maybe ThingGroupMetadata)

Thing group metadata.

describeThingGroupResponse_thingGroupName :: Lens' DescribeThingGroupResponse (Maybe Text)

The name of the thing group.

describeThingGroupResponse_thingGroupProperties :: Lens' DescribeThingGroupResponse (Maybe ThingGroupProperties)

The thing group properties.

describeThingGroupResponse_version :: Lens' DescribeThingGroupResponse (Maybe Integer)

The version of the thing group.

describeThingGroupResponse_httpStatus :: Lens' DescribeThingGroupResponse Int

The response's http status code.