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.GetPropertyValue

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Synopsis

data GetPropertyValue = GetPropertyValue' {
- componentName :: Maybe Text
- componentTypeId :: Maybe Text
- entityId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- propertyGroupName :: Maybe Text
- tabularConditions :: Maybe TabularConditions
- selectedProperties :: NonEmpty Text
- workspaceId :: Text
}
newGetPropertyValue :: NonEmpty Text -> Text -> GetPropertyValue
getPropertyValue_componentName :: Lens' GetPropertyValue (Maybe Text)
getPropertyValue_componentTypeId :: Lens' GetPropertyValue (Maybe Text)
getPropertyValue_entityId :: Lens' GetPropertyValue (Maybe Text)
getPropertyValue_maxResults :: Lens' GetPropertyValue (Maybe Natural)
getPropertyValue_nextToken :: Lens' GetPropertyValue (Maybe Text)
getPropertyValue_propertyGroupName :: Lens' GetPropertyValue (Maybe Text)
getPropertyValue_tabularConditions :: Lens' GetPropertyValue (Maybe TabularConditions)
getPropertyValue_selectedProperties :: Lens' GetPropertyValue (NonEmpty Text)
getPropertyValue_workspaceId :: Lens' GetPropertyValue Text
data GetPropertyValueResponse = GetPropertyValueResponse' {
- nextToken :: Maybe Text
- propertyValues :: Maybe (HashMap Text PropertyLatestValue)
- tabularPropertyValues :: Maybe [[HashMap Text DataValue]]
- httpStatus :: Int
}
newGetPropertyValueResponse :: Int -> GetPropertyValueResponse
getPropertyValueResponse_nextToken :: Lens' GetPropertyValueResponse (Maybe Text)
getPropertyValueResponse_propertyValues :: Lens' GetPropertyValueResponse (Maybe (HashMap Text PropertyLatestValue))
getPropertyValueResponse_tabularPropertyValues :: Lens' GetPropertyValueResponse (Maybe [[HashMap Text DataValue]])
getPropertyValueResponse_httpStatus :: Lens' GetPropertyValueResponse Int

Creating a Request

data GetPropertyValue Source #

See: newGetPropertyValue smart constructor.

Constructors

GetPropertyValue'

Fields

componentName :: Maybe Text
The name of the component whose property values the operation returns.
componentTypeId :: Maybe Text
The ID of the component type whose property values the operation returns.
entityId :: Maybe Text
The ID of the entity whose property values the operation returns.
maxResults :: Maybe Natural
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
nextToken :: Maybe Text
The string that specifies the next page of results.
propertyGroupName :: Maybe Text
The property group name.
tabularConditions :: Maybe TabularConditions
The tabular conditions.
selectedProperties :: NonEmpty Text
The properties whose values the operation returns.
workspaceId :: Text
The ID of the workspace whose values the operation returns.

Instances

Instances details

ToJSON GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods toJSON :: GetPropertyValue -> Value # toEncoding :: GetPropertyValue -> Encoding # toJSONList :: [GetPropertyValue] -> Value # toEncodingList :: [GetPropertyValue] -> Encoding #
ToHeaders GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods toHeaders :: GetPropertyValue -> [Header] #
ToPath GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods toPath :: GetPropertyValue -> ByteString #
ToQuery GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods toQuery :: GetPropertyValue -> QueryString #
AWSRequest GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Associated Types type AWSResponse GetPropertyValue # Methods request :: (Service -> Service) -> GetPropertyValue -> Request GetPropertyValue # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPropertyValue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPropertyValue))) #
Generic GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Associated Types type Rep GetPropertyValue :: Type -> Type # Methods from :: GetPropertyValue -> Rep GetPropertyValue x # to :: Rep GetPropertyValue x -> GetPropertyValue #
Read GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods readsPrec :: Int -> ReadS GetPropertyValue # readList :: ReadS [GetPropertyValue] # readPrec :: ReadPrec GetPropertyValue # readListPrec :: ReadPrec [GetPropertyValue] #
Show GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods showsPrec :: Int -> GetPropertyValue -> ShowS # show :: GetPropertyValue -> String # showList :: [GetPropertyValue] -> ShowS #
NFData GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods rnf :: GetPropertyValue -> () #
Eq GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods (==) :: GetPropertyValue -> GetPropertyValue -> Bool # (/=) :: GetPropertyValue -> GetPropertyValue -> Bool #
Hashable GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods hashWithSalt :: Int -> GetPropertyValue -> Int # hash :: GetPropertyValue -> Int #
type AWSResponse GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue type AWSResponse GetPropertyValue = GetPropertyValueResponse
type Rep GetPropertyValue Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue type Rep GetPropertyValue = D1 ('MetaData "GetPropertyValue" "Amazonka.IotTwinMaker.GetPropertyValue" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetPropertyValue'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "componentTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tabularConditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TabularConditions)) :: (S1 ('MetaSel ('Just "selectedProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetPropertyValue Source #

Arguments

:: NonEmpty Text	`$sel:selectedProperties:GetPropertyValue'`
-> Text	`GetPropertyValue`
-> GetPropertyValue

Create a value of GetPropertyValue 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:

GetPropertyValue, getPropertyValue_componentName - The name of the component whose property values the operation returns.

GetPropertyValue, getPropertyValue_componentTypeId - The ID of the component type whose property values the operation returns.

GetPropertyValue, getPropertyValue_entityId - The ID of the entity whose property values the operation returns.

$sel:maxResults:GetPropertyValue', getPropertyValue_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.

GetPropertyValue, getPropertyValue_nextToken - The string that specifies the next page of results.

$sel:propertyGroupName:GetPropertyValue', getPropertyValue_propertyGroupName - The property group name.

$sel:tabularConditions:GetPropertyValue', getPropertyValue_tabularConditions - The tabular conditions.

$sel:selectedProperties:GetPropertyValue', getPropertyValue_selectedProperties - The properties whose values the operation returns.

GetPropertyValue, getPropertyValue_workspaceId - The ID of the workspace whose values the operation returns.

Request Lenses

getPropertyValue_componentName :: Lens' GetPropertyValue (Maybe Text) Source #

The name of the component whose property values the operation returns.

getPropertyValue_componentTypeId :: Lens' GetPropertyValue (Maybe Text) Source #

The ID of the component type whose property values the operation returns.

getPropertyValue_entityId :: Lens' GetPropertyValue (Maybe Text) Source #

The ID of the entity whose property values the operation returns.

getPropertyValue_maxResults :: Lens' GetPropertyValue (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.

getPropertyValue_nextToken :: Lens' GetPropertyValue (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValue_propertyGroupName :: Lens' GetPropertyValue (Maybe Text) Source #

The property group name.

getPropertyValue_tabularConditions :: Lens' GetPropertyValue (Maybe TabularConditions) Source #

The tabular conditions.

getPropertyValue_selectedProperties :: Lens' GetPropertyValue (NonEmpty Text) Source #

The properties whose values the operation returns.

getPropertyValue_workspaceId :: Lens' GetPropertyValue Text Source #

The ID of the workspace whose values the operation returns.

Destructuring the Response

data GetPropertyValueResponse Source #

See: newGetPropertyValueResponse smart constructor.

Constructors

GetPropertyValueResponse'

Fields

nextToken :: Maybe Text
The string that specifies the next page of results.
propertyValues :: Maybe (HashMap Text PropertyLatestValue)
An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.
tabularPropertyValues :: Maybe [[HashMap Text DataValue]]
A table of property values.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Associated Types type Rep GetPropertyValueResponse :: Type -> Type # Methods from :: GetPropertyValueResponse -> Rep GetPropertyValueResponse x # to :: Rep GetPropertyValueResponse x -> GetPropertyValueResponse #
Read GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods readsPrec :: Int -> ReadS GetPropertyValueResponse # readList :: ReadS [GetPropertyValueResponse] # readPrec :: ReadPrec GetPropertyValueResponse # readListPrec :: ReadPrec [GetPropertyValueResponse] #
Show GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods showsPrec :: Int -> GetPropertyValueResponse -> ShowS # show :: GetPropertyValueResponse -> String # showList :: [GetPropertyValueResponse] -> ShowS #
NFData GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods rnf :: GetPropertyValueResponse -> () #
Eq GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue Methods (==) :: GetPropertyValueResponse -> GetPropertyValueResponse -> Bool # (/=) :: GetPropertyValueResponse -> GetPropertyValueResponse -> Bool #
type Rep GetPropertyValueResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValue type Rep GetPropertyValueResponse = D1 ('MetaData "GetPropertyValueResponse" "Amazonka.IotTwinMaker.GetPropertyValue" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetPropertyValueResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PropertyLatestValue)))) :: (S1 ('MetaSel ('Just "tabularPropertyValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[HashMap Text DataValue]])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetPropertyValueResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetPropertyValueResponse'`
-> GetPropertyValueResponse

Create a value of GetPropertyValueResponse 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:

GetPropertyValue, getPropertyValueResponse_nextToken - The string that specifies the next page of results.

GetPropertyValueResponse, getPropertyValueResponse_propertyValues - An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

$sel:tabularPropertyValues:GetPropertyValueResponse', getPropertyValueResponse_tabularPropertyValues - A table of property values.

$sel:httpStatus:GetPropertyValueResponse', getPropertyValueResponse_httpStatus - The response's http status code.

Response Lenses

getPropertyValueResponse_nextToken :: Lens' GetPropertyValueResponse (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueResponse_propertyValues :: Lens' GetPropertyValueResponse (Maybe (HashMap Text PropertyLatestValue)) Source #

An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

getPropertyValueResponse_tabularPropertyValues :: Lens' GetPropertyValueResponse (Maybe [[HashMap Text DataValue]]) Source #

A table of property values.

getPropertyValueResponse_httpStatus :: Lens' GetPropertyValueResponse Int Source #

The response's http status code.