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 |
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' {}
- 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' {}
- 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.
GetPropertyValue' | |
|
Instances
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.
GetPropertyValueResponse' | |
|
Instances
newGetPropertyValueResponse Source #
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.