| 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 |
Amazonka.IoTThingsGraph.Types
Contents
- Service Configuration
- Errors
- DefinitionLanguage
- DeploymentTarget
- EntityFilterName
- EntityType
- FlowExecutionEventType
- FlowExecutionStatus
- FlowTemplateFilterName
- NamespaceDeletionStatus
- NamespaceDeletionStatusErrorCodes
- SystemInstanceDeploymentStatus
- SystemInstanceFilterName
- SystemTemplateFilterName
- UploadStatus
- DefinitionDocument
- DependencyRevision
- EntityDescription
- EntityFilter
- FlowExecutionMessage
- FlowExecutionSummary
- FlowTemplateDescription
- FlowTemplateFilter
- FlowTemplateSummary
- MetricsConfiguration
- SystemInstanceDescription
- SystemInstanceFilter
- SystemInstanceSummary
- SystemTemplateDescription
- SystemTemplateFilter
- SystemTemplateSummary
- Tag
- Thing
Description
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype DefinitionLanguage where
- newtype DeploymentTarget where
- DeploymentTarget' { }
- pattern DeploymentTarget_CLOUD :: DeploymentTarget
- pattern DeploymentTarget_GREENGRASS :: DeploymentTarget
- newtype EntityFilterName where
- EntityFilterName' { }
- pattern EntityFilterName_NAME :: EntityFilterName
- pattern EntityFilterName_NAMESPACE :: EntityFilterName
- pattern EntityFilterName_REFERENCED_ENTITY_ID :: EntityFilterName
- pattern EntityFilterName_SEMANTIC_TYPE_PATH :: EntityFilterName
- newtype EntityType where
- EntityType' { }
- pattern EntityType_ACTION :: EntityType
- pattern EntityType_CAPABILITY :: EntityType
- pattern EntityType_DEVICE :: EntityType
- pattern EntityType_DEVICE_MODEL :: EntityType
- pattern EntityType_ENUM :: EntityType
- pattern EntityType_EVENT :: EntityType
- pattern EntityType_MAPPING :: EntityType
- pattern EntityType_PROPERTY :: EntityType
- pattern EntityType_SERVICE :: EntityType
- pattern EntityType_STATE :: EntityType
- newtype FlowExecutionEventType where
- FlowExecutionEventType' { }
- pattern FlowExecutionEventType_ACKNOWLEDGE_TASK_MESSAGE :: FlowExecutionEventType
- pattern FlowExecutionEventType_ACTIVITY_FAILED :: FlowExecutionEventType
- pattern FlowExecutionEventType_ACTIVITY_SCHEDULED :: FlowExecutionEventType
- pattern FlowExecutionEventType_ACTIVITY_STARTED :: FlowExecutionEventType
- pattern FlowExecutionEventType_ACTIVITY_SUCCEEDED :: FlowExecutionEventType
- pattern FlowExecutionEventType_EXECUTION_ABORTED :: FlowExecutionEventType
- pattern FlowExecutionEventType_EXECUTION_FAILED :: FlowExecutionEventType
- pattern FlowExecutionEventType_EXECUTION_STARTED :: FlowExecutionEventType
- pattern FlowExecutionEventType_EXECUTION_SUCCEEDED :: FlowExecutionEventType
- pattern FlowExecutionEventType_SCHEDULE_NEXT_READY_STEPS_TASK :: FlowExecutionEventType
- pattern FlowExecutionEventType_START_FLOW_EXECUTION_TASK :: FlowExecutionEventType
- pattern FlowExecutionEventType_STEP_FAILED :: FlowExecutionEventType
- pattern FlowExecutionEventType_STEP_STARTED :: FlowExecutionEventType
- pattern FlowExecutionEventType_STEP_SUCCEEDED :: FlowExecutionEventType
- pattern FlowExecutionEventType_THING_ACTION_TASK :: FlowExecutionEventType
- pattern FlowExecutionEventType_THING_ACTION_TASK_FAILED :: FlowExecutionEventType
- pattern FlowExecutionEventType_THING_ACTION_TASK_SUCCEEDED :: FlowExecutionEventType
- newtype FlowExecutionStatus where
- newtype FlowTemplateFilterName where
- newtype NamespaceDeletionStatus where
- newtype NamespaceDeletionStatusErrorCodes where
- newtype SystemInstanceDeploymentStatus where
- SystemInstanceDeploymentStatus' { }
- pattern SystemInstanceDeploymentStatus_BOOTSTRAP :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_DELETED_IN_TARGET :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_DEPLOYED_IN_TARGET :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_DEPLOY_IN_PROGRESS :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_FAILED :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_NOT_DEPLOYED :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_PENDING_DELETE :: SystemInstanceDeploymentStatus
- pattern SystemInstanceDeploymentStatus_UNDEPLOY_IN_PROGRESS :: SystemInstanceDeploymentStatus
- newtype SystemInstanceFilterName where
- newtype SystemTemplateFilterName where
- newtype UploadStatus where
- UploadStatus' { }
- pattern UploadStatus_FAILED :: UploadStatus
- pattern UploadStatus_IN_PROGRESS :: UploadStatus
- pattern UploadStatus_SUCCEEDED :: UploadStatus
- data DefinitionDocument = DefinitionDocument' {}
- newDefinitionDocument :: DefinitionLanguage -> Text -> DefinitionDocument
- definitionDocument_language :: Lens' DefinitionDocument DefinitionLanguage
- definitionDocument_text :: Lens' DefinitionDocument Text
- data DependencyRevision = DependencyRevision' {}
- newDependencyRevision :: DependencyRevision
- dependencyRevision_revisionNumber :: Lens' DependencyRevision (Maybe Integer)
- dependencyRevision_id :: Lens' DependencyRevision (Maybe Text)
- data EntityDescription = EntityDescription' {
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- definition :: Maybe DefinitionDocument
- id :: Maybe Text
- type' :: Maybe EntityType
- newEntityDescription :: EntityDescription
- entityDescription_arn :: Lens' EntityDescription (Maybe Text)
- entityDescription_createdAt :: Lens' EntityDescription (Maybe UTCTime)
- entityDescription_definition :: Lens' EntityDescription (Maybe DefinitionDocument)
- entityDescription_id :: Lens' EntityDescription (Maybe Text)
- entityDescription_type :: Lens' EntityDescription (Maybe EntityType)
- data EntityFilter = EntityFilter' {}
- newEntityFilter :: EntityFilter
- entityFilter_value :: Lens' EntityFilter (Maybe [Text])
- entityFilter_name :: Lens' EntityFilter (Maybe EntityFilterName)
- data FlowExecutionMessage = FlowExecutionMessage' {}
- newFlowExecutionMessage :: FlowExecutionMessage
- flowExecutionMessage_payload :: Lens' FlowExecutionMessage (Maybe Text)
- flowExecutionMessage_eventType :: Lens' FlowExecutionMessage (Maybe FlowExecutionEventType)
- flowExecutionMessage_timestamp :: Lens' FlowExecutionMessage (Maybe UTCTime)
- flowExecutionMessage_messageId :: Lens' FlowExecutionMessage (Maybe Text)
- data FlowExecutionSummary = FlowExecutionSummary' {}
- newFlowExecutionSummary :: FlowExecutionSummary
- flowExecutionSummary_status :: Lens' FlowExecutionSummary (Maybe FlowExecutionStatus)
- flowExecutionSummary_flowTemplateId :: Lens' FlowExecutionSummary (Maybe Text)
- flowExecutionSummary_createdAt :: Lens' FlowExecutionSummary (Maybe UTCTime)
- flowExecutionSummary_flowExecutionId :: Lens' FlowExecutionSummary (Maybe Text)
- flowExecutionSummary_systemInstanceId :: Lens' FlowExecutionSummary (Maybe Text)
- flowExecutionSummary_updatedAt :: Lens' FlowExecutionSummary (Maybe UTCTime)
- data FlowTemplateDescription = FlowTemplateDescription' {}
- newFlowTemplateDescription :: FlowTemplateDescription
- flowTemplateDescription_summary :: Lens' FlowTemplateDescription (Maybe FlowTemplateSummary)
- flowTemplateDescription_definition :: Lens' FlowTemplateDescription (Maybe DefinitionDocument)
- flowTemplateDescription_validatedNamespaceVersion :: Lens' FlowTemplateDescription (Maybe Integer)
- data FlowTemplateFilter = FlowTemplateFilter' {
- name :: FlowTemplateFilterName
- value :: [Text]
- newFlowTemplateFilter :: FlowTemplateFilterName -> FlowTemplateFilter
- flowTemplateFilter_name :: Lens' FlowTemplateFilter FlowTemplateFilterName
- flowTemplateFilter_value :: Lens' FlowTemplateFilter [Text]
- data FlowTemplateSummary = FlowTemplateSummary' {}
- newFlowTemplateSummary :: FlowTemplateSummary
- flowTemplateSummary_arn :: Lens' FlowTemplateSummary (Maybe Text)
- flowTemplateSummary_createdAt :: Lens' FlowTemplateSummary (Maybe UTCTime)
- flowTemplateSummary_revisionNumber :: Lens' FlowTemplateSummary (Maybe Integer)
- flowTemplateSummary_id :: Lens' FlowTemplateSummary (Maybe Text)
- data MetricsConfiguration = MetricsConfiguration' {}
- newMetricsConfiguration :: MetricsConfiguration
- metricsConfiguration_cloudMetricEnabled :: Lens' MetricsConfiguration (Maybe Bool)
- metricsConfiguration_metricRuleRoleArn :: Lens' MetricsConfiguration (Maybe Text)
- data SystemInstanceDescription = SystemInstanceDescription' {}
- newSystemInstanceDescription :: SystemInstanceDescription
- systemInstanceDescription_summary :: Lens' SystemInstanceDescription (Maybe SystemInstanceSummary)
- systemInstanceDescription_metricsConfiguration :: Lens' SystemInstanceDescription (Maybe MetricsConfiguration)
- systemInstanceDescription_validatedDependencyRevisions :: Lens' SystemInstanceDescription (Maybe [DependencyRevision])
- systemInstanceDescription_definition :: Lens' SystemInstanceDescription (Maybe DefinitionDocument)
- systemInstanceDescription_validatedNamespaceVersion :: Lens' SystemInstanceDescription (Maybe Integer)
- systemInstanceDescription_flowActionsRoleArn :: Lens' SystemInstanceDescription (Maybe Text)
- systemInstanceDescription_s3BucketName :: Lens' SystemInstanceDescription (Maybe Text)
- data SystemInstanceFilter = SystemInstanceFilter' {}
- newSystemInstanceFilter :: SystemInstanceFilter
- systemInstanceFilter_value :: Lens' SystemInstanceFilter (Maybe [Text])
- systemInstanceFilter_name :: Lens' SystemInstanceFilter (Maybe SystemInstanceFilterName)
- data SystemInstanceSummary = SystemInstanceSummary' {}
- newSystemInstanceSummary :: SystemInstanceSummary
- systemInstanceSummary_status :: Lens' SystemInstanceSummary (Maybe SystemInstanceDeploymentStatus)
- systemInstanceSummary_greengrassGroupName :: Lens' SystemInstanceSummary (Maybe Text)
- systemInstanceSummary_arn :: Lens' SystemInstanceSummary (Maybe Text)
- systemInstanceSummary_createdAt :: Lens' SystemInstanceSummary (Maybe UTCTime)
- systemInstanceSummary_greengrassGroupId :: Lens' SystemInstanceSummary (Maybe Text)
- systemInstanceSummary_greengrassGroupVersionId :: Lens' SystemInstanceSummary (Maybe Text)
- systemInstanceSummary_id :: Lens' SystemInstanceSummary (Maybe Text)
- systemInstanceSummary_updatedAt :: Lens' SystemInstanceSummary (Maybe UTCTime)
- systemInstanceSummary_target :: Lens' SystemInstanceSummary (Maybe DeploymentTarget)
- data SystemTemplateDescription = SystemTemplateDescription' {}
- newSystemTemplateDescription :: SystemTemplateDescription
- systemTemplateDescription_summary :: Lens' SystemTemplateDescription (Maybe SystemTemplateSummary)
- systemTemplateDescription_definition :: Lens' SystemTemplateDescription (Maybe DefinitionDocument)
- systemTemplateDescription_validatedNamespaceVersion :: Lens' SystemTemplateDescription (Maybe Integer)
- data SystemTemplateFilter = SystemTemplateFilter' {
- name :: SystemTemplateFilterName
- value :: [Text]
- newSystemTemplateFilter :: SystemTemplateFilterName -> SystemTemplateFilter
- systemTemplateFilter_name :: Lens' SystemTemplateFilter SystemTemplateFilterName
- systemTemplateFilter_value :: Lens' SystemTemplateFilter [Text]
- data SystemTemplateSummary = SystemTemplateSummary' {}
- newSystemTemplateSummary :: SystemTemplateSummary
- systemTemplateSummary_arn :: Lens' SystemTemplateSummary (Maybe Text)
- systemTemplateSummary_createdAt :: Lens' SystemTemplateSummary (Maybe UTCTime)
- systemTemplateSummary_revisionNumber :: Lens' SystemTemplateSummary (Maybe Integer)
- systemTemplateSummary_id :: Lens' SystemTemplateSummary (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Thing = Thing' {}
- newThing :: Thing
- thing_thingArn :: Lens' Thing (Maybe Text)
- thing_thingName :: Lens' Thing (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-09-06 of the Amazon IoT Things Graph SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
DefinitionLanguage
newtype DefinitionLanguage Source #
Constructors
| DefinitionLanguage' | |
Fields | |
Bundled Patterns
| pattern DefinitionLanguage_GRAPHQL :: DefinitionLanguage |
Instances
DeploymentTarget
newtype DeploymentTarget Source #
Constructors
| DeploymentTarget' | |
Fields | |
Bundled Patterns
| pattern DeploymentTarget_CLOUD :: DeploymentTarget | |
| pattern DeploymentTarget_GREENGRASS :: DeploymentTarget |
Instances
EntityFilterName
newtype EntityFilterName Source #
Constructors
| EntityFilterName' | |
Fields | |
Bundled Patterns
| pattern EntityFilterName_NAME :: EntityFilterName | |
| pattern EntityFilterName_NAMESPACE :: EntityFilterName | |
| pattern EntityFilterName_REFERENCED_ENTITY_ID :: EntityFilterName | |
| pattern EntityFilterName_SEMANTIC_TYPE_PATH :: EntityFilterName |
Instances
EntityType
newtype EntityType Source #
Constructors
| EntityType' | |
Fields | |
Bundled Patterns
| pattern EntityType_ACTION :: EntityType | |
| pattern EntityType_CAPABILITY :: EntityType | |
| pattern EntityType_DEVICE :: EntityType | |
| pattern EntityType_DEVICE_MODEL :: EntityType | |
| pattern EntityType_ENUM :: EntityType | |
| pattern EntityType_EVENT :: EntityType | |
| pattern EntityType_MAPPING :: EntityType | |
| pattern EntityType_PROPERTY :: EntityType | |
| pattern EntityType_SERVICE :: EntityType | |
| pattern EntityType_STATE :: EntityType |
Instances
FlowExecutionEventType
newtype FlowExecutionEventType Source #
Constructors
| FlowExecutionEventType' | |
Fields | |
Bundled Patterns
Instances
FlowExecutionStatus
newtype FlowExecutionStatus Source #
Constructors
| FlowExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern FlowExecutionStatus_ABORTED :: FlowExecutionStatus | |
| pattern FlowExecutionStatus_FAILED :: FlowExecutionStatus | |
| pattern FlowExecutionStatus_RUNNING :: FlowExecutionStatus | |
| pattern FlowExecutionStatus_SUCCEEDED :: FlowExecutionStatus |
Instances
FlowTemplateFilterName
newtype FlowTemplateFilterName Source #
Constructors
| FlowTemplateFilterName' | |
Fields | |
Bundled Patterns
| pattern FlowTemplateFilterName_DEVICE_MODEL_ID :: FlowTemplateFilterName |
Instances
NamespaceDeletionStatus
newtype NamespaceDeletionStatus Source #
Constructors
| NamespaceDeletionStatus' | |
Fields | |
Bundled Patterns
Instances
NamespaceDeletionStatusErrorCodes
newtype NamespaceDeletionStatusErrorCodes Source #
Constructors
| NamespaceDeletionStatusErrorCodes' | |
Bundled Patterns
| pattern NamespaceDeletionStatusErrorCodes_VALIDATION_FAILED :: NamespaceDeletionStatusErrorCodes |
Instances
SystemInstanceDeploymentStatus
newtype SystemInstanceDeploymentStatus Source #
Constructors
| SystemInstanceDeploymentStatus' | |
Fields | |
Bundled Patterns
Instances
SystemInstanceFilterName
newtype SystemInstanceFilterName Source #
Constructors
| SystemInstanceFilterName' | |
Fields | |
Bundled Patterns
Instances
SystemTemplateFilterName
newtype SystemTemplateFilterName Source #
Constructors
| SystemTemplateFilterName' | |
Fields | |
Bundled Patterns
| pattern SystemTemplateFilterName_FLOW_TEMPLATE_ID :: SystemTemplateFilterName |
Instances
UploadStatus
newtype UploadStatus Source #
Constructors
| UploadStatus' | |
Fields | |
Bundled Patterns
| pattern UploadStatus_FAILED :: UploadStatus | |
| pattern UploadStatus_IN_PROGRESS :: UploadStatus | |
| pattern UploadStatus_SUCCEEDED :: UploadStatus |
Instances
DefinitionDocument
data DefinitionDocument Source #
A document that defines an entity.
See: newDefinitionDocument smart constructor.
Constructors
| DefinitionDocument' | |
Fields
| |
Instances
newDefinitionDocument Source #
Arguments
| :: DefinitionLanguage | |
| -> Text | |
| -> DefinitionDocument |
Create a value of DefinitionDocument 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:language:DefinitionDocument', definitionDocument_language - The language used to define the entity. GRAPHQL is the only valid
value.
$sel:text:DefinitionDocument', definitionDocument_text - The GraphQL text that defines the entity.
definitionDocument_language :: Lens' DefinitionDocument DefinitionLanguage Source #
The language used to define the entity. GRAPHQL is the only valid
value.
definitionDocument_text :: Lens' DefinitionDocument Text Source #
The GraphQL text that defines the entity.
DependencyRevision
data DependencyRevision Source #
An object that contains the ID and revision number of a workflow or system that is part of a deployment.
See: newDependencyRevision smart constructor.
Constructors
| DependencyRevision' | |
Instances
newDependencyRevision :: DependencyRevision Source #
Create a value of DependencyRevision 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:revisionNumber:DependencyRevision', dependencyRevision_revisionNumber - The revision number of the workflow or system.
$sel:id:DependencyRevision', dependencyRevision_id - The ID of the workflow or system.
dependencyRevision_revisionNumber :: Lens' DependencyRevision (Maybe Integer) Source #
The revision number of the workflow or system.
dependencyRevision_id :: Lens' DependencyRevision (Maybe Text) Source #
The ID of the workflow or system.
EntityDescription
data EntityDescription Source #
Describes the properties of an entity.
See: newEntityDescription smart constructor.
Constructors
| EntityDescription' | |
Fields
| |
Instances
newEntityDescription :: EntityDescription Source #
Create a value of EntityDescription 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:arn:EntityDescription', entityDescription_arn - The entity ARN.
$sel:createdAt:EntityDescription', entityDescription_createdAt - The time at which the entity was created.
$sel:definition:EntityDescription', entityDescription_definition - The definition document of the entity.
$sel:id:EntityDescription', entityDescription_id - The entity ID.
$sel:type':EntityDescription', entityDescription_type - The entity type.
entityDescription_arn :: Lens' EntityDescription (Maybe Text) Source #
The entity ARN.
entityDescription_createdAt :: Lens' EntityDescription (Maybe UTCTime) Source #
The time at which the entity was created.
entityDescription_definition :: Lens' EntityDescription (Maybe DefinitionDocument) Source #
The definition document of the entity.
entityDescription_id :: Lens' EntityDescription (Maybe Text) Source #
The entity ID.
entityDescription_type :: Lens' EntityDescription (Maybe EntityType) Source #
The entity type.
EntityFilter
data EntityFilter Source #
An object that filters an entity search. Multiple filters function as OR
criteria in the search. For example a search that includes a NAMESPACE
and a REFERENCED_ENTITY_ID filter searches for entities in the
specified namespace that use the entity specified by the value of
REFERENCED_ENTITY_ID.
See: newEntityFilter smart constructor.
Constructors
| EntityFilter' | |
Fields
| |
Instances
newEntityFilter :: EntityFilter Source #
Create a value of EntityFilter 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:value:EntityFilter', entityFilter_value - An array of string values for the search filter field. Multiple values
function as AND criteria in the search.
$sel:name:EntityFilter', entityFilter_name - The name of the entity search filter field. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For
example, you can filter on the ID of a property that is used in a state.
entityFilter_value :: Lens' EntityFilter (Maybe [Text]) Source #
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
entityFilter_name :: Lens' EntityFilter (Maybe EntityFilterName) Source #
The name of the entity search filter field. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For
example, you can filter on the ID of a property that is used in a state.
FlowExecutionMessage
data FlowExecutionMessage Source #
An object that contains information about a flow event.
See: newFlowExecutionMessage smart constructor.
Constructors
| FlowExecutionMessage' | |
Instances
newFlowExecutionMessage :: FlowExecutionMessage Source #
Create a value of FlowExecutionMessage 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:payload:FlowExecutionMessage', flowExecutionMessage_payload - A string containing information about the flow event.
$sel:eventType:FlowExecutionMessage', flowExecutionMessage_eventType - The type of flow event .
$sel:timestamp:FlowExecutionMessage', flowExecutionMessage_timestamp - The date and time when the message was last updated.
$sel:messageId:FlowExecutionMessage', flowExecutionMessage_messageId - The unique identifier of the message.
flowExecutionMessage_payload :: Lens' FlowExecutionMessage (Maybe Text) Source #
A string containing information about the flow event.
flowExecutionMessage_eventType :: Lens' FlowExecutionMessage (Maybe FlowExecutionEventType) Source #
The type of flow event .
flowExecutionMessage_timestamp :: Lens' FlowExecutionMessage (Maybe UTCTime) Source #
The date and time when the message was last updated.
flowExecutionMessage_messageId :: Lens' FlowExecutionMessage (Maybe Text) Source #
The unique identifier of the message.
FlowExecutionSummary
data FlowExecutionSummary Source #
An object that contains summary information about a flow execution.
See: newFlowExecutionSummary smart constructor.
Constructors
| FlowExecutionSummary' | |
Fields
| |
Instances
newFlowExecutionSummary :: FlowExecutionSummary Source #
Create a value of FlowExecutionSummary 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:FlowExecutionSummary', flowExecutionSummary_status - The current status of the flow execution.
$sel:flowTemplateId:FlowExecutionSummary', flowExecutionSummary_flowTemplateId - The ID of the flow.
$sel:createdAt:FlowExecutionSummary', flowExecutionSummary_createdAt - The date and time when the flow execution summary was created.
$sel:flowExecutionId:FlowExecutionSummary', flowExecutionSummary_flowExecutionId - The ID of the flow execution.
$sel:systemInstanceId:FlowExecutionSummary', flowExecutionSummary_systemInstanceId - The ID of the system instance that contains the flow.
$sel:updatedAt:FlowExecutionSummary', flowExecutionSummary_updatedAt - The date and time when the flow execution summary was last updated.
flowExecutionSummary_status :: Lens' FlowExecutionSummary (Maybe FlowExecutionStatus) Source #
The current status of the flow execution.
flowExecutionSummary_flowTemplateId :: Lens' FlowExecutionSummary (Maybe Text) Source #
The ID of the flow.
flowExecutionSummary_createdAt :: Lens' FlowExecutionSummary (Maybe UTCTime) Source #
The date and time when the flow execution summary was created.
flowExecutionSummary_flowExecutionId :: Lens' FlowExecutionSummary (Maybe Text) Source #
The ID of the flow execution.
flowExecutionSummary_systemInstanceId :: Lens' FlowExecutionSummary (Maybe Text) Source #
The ID of the system instance that contains the flow.
flowExecutionSummary_updatedAt :: Lens' FlowExecutionSummary (Maybe UTCTime) Source #
The date and time when the flow execution summary was last updated.
FlowTemplateDescription
data FlowTemplateDescription Source #
An object that contains a workflow's definition and summary information.
See: newFlowTemplateDescription smart constructor.
Constructors
| FlowTemplateDescription' | |
Fields
| |
Instances
newFlowTemplateDescription :: FlowTemplateDescription Source #
Create a value of FlowTemplateDescription 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:summary:FlowTemplateDescription', flowTemplateDescription_summary - An object that contains summary information about a workflow.
$sel:definition:FlowTemplateDescription', flowTemplateDescription_definition - A workflow's definition document.
$sel:validatedNamespaceVersion:FlowTemplateDescription', flowTemplateDescription_validatedNamespaceVersion - The version of the user's namespace against which the workflow was
validated. Use this value in your system instance.
flowTemplateDescription_summary :: Lens' FlowTemplateDescription (Maybe FlowTemplateSummary) Source #
An object that contains summary information about a workflow.
flowTemplateDescription_definition :: Lens' FlowTemplateDescription (Maybe DefinitionDocument) Source #
A workflow's definition document.
flowTemplateDescription_validatedNamespaceVersion :: Lens' FlowTemplateDescription (Maybe Integer) Source #
The version of the user's namespace against which the workflow was validated. Use this value in your system instance.
FlowTemplateFilter
data FlowTemplateFilter Source #
An object that filters a workflow search.
See: newFlowTemplateFilter smart constructor.
Constructors
| FlowTemplateFilter' | |
Fields
| |
Instances
newFlowTemplateFilter Source #
Create a value of FlowTemplateFilter 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:name:FlowTemplateFilter', flowTemplateFilter_name - The name of the search filter field.
$sel:value:FlowTemplateFilter', flowTemplateFilter_value - An array of string values for the search filter field. Multiple values
function as AND criteria in the search.
flowTemplateFilter_name :: Lens' FlowTemplateFilter FlowTemplateFilterName Source #
The name of the search filter field.
flowTemplateFilter_value :: Lens' FlowTemplateFilter [Text] Source #
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
FlowTemplateSummary
data FlowTemplateSummary Source #
An object that contains summary information about a workflow.
See: newFlowTemplateSummary smart constructor.
Constructors
| FlowTemplateSummary' | |
Instances
newFlowTemplateSummary :: FlowTemplateSummary Source #
Create a value of FlowTemplateSummary 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:arn:FlowTemplateSummary', flowTemplateSummary_arn - The ARN of the workflow.
$sel:createdAt:FlowTemplateSummary', flowTemplateSummary_createdAt - The date when the workflow was created.
$sel:revisionNumber:FlowTemplateSummary', flowTemplateSummary_revisionNumber - The revision number of the workflow.
$sel:id:FlowTemplateSummary', flowTemplateSummary_id - The ID of the workflow.
flowTemplateSummary_arn :: Lens' FlowTemplateSummary (Maybe Text) Source #
The ARN of the workflow.
flowTemplateSummary_createdAt :: Lens' FlowTemplateSummary (Maybe UTCTime) Source #
The date when the workflow was created.
flowTemplateSummary_revisionNumber :: Lens' FlowTemplateSummary (Maybe Integer) Source #
The revision number of the workflow.
flowTemplateSummary_id :: Lens' FlowTemplateSummary (Maybe Text) Source #
The ID of the workflow.
MetricsConfiguration
data MetricsConfiguration Source #
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
See: newMetricsConfiguration smart constructor.
Constructors
| MetricsConfiguration' | |
Fields
| |
Instances
newMetricsConfiguration :: MetricsConfiguration Source #
Create a value of MetricsConfiguration 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:cloudMetricEnabled:MetricsConfiguration', metricsConfiguration_cloudMetricEnabled - A Boolean that specifies whether cloud metrics are collected.
$sel:metricRuleRoleArn:MetricsConfiguration', metricsConfiguration_metricRuleRoleArn - The ARN of the role that is used to collect cloud metrics.
metricsConfiguration_cloudMetricEnabled :: Lens' MetricsConfiguration (Maybe Bool) Source #
A Boolean that specifies whether cloud metrics are collected.
metricsConfiguration_metricRuleRoleArn :: Lens' MetricsConfiguration (Maybe Text) Source #
The ARN of the role that is used to collect cloud metrics.
SystemInstanceDescription
data SystemInstanceDescription Source #
An object that contains a system instance definition and summary information.
See: newSystemInstanceDescription smart constructor.
Constructors
| SystemInstanceDescription' | |
Fields
| |
Instances
newSystemInstanceDescription :: SystemInstanceDescription Source #
Create a value of SystemInstanceDescription 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:summary:SystemInstanceDescription', systemInstanceDescription_summary - An object that contains summary information about a system instance.
$sel:metricsConfiguration:SystemInstanceDescription', systemInstanceDescription_metricsConfiguration - Undocumented member.
$sel:validatedDependencyRevisions:SystemInstanceDescription', systemInstanceDescription_validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of
workflows and systems that are used in a system instance.
$sel:definition:SystemInstanceDescription', systemInstanceDescription_definition - Undocumented member.
$sel:validatedNamespaceVersion:SystemInstanceDescription', systemInstanceDescription_validatedNamespaceVersion - The version of the user's namespace against which the system instance
was validated.
$sel:flowActionsRoleArn:SystemInstanceDescription', systemInstanceDescription_flowActionsRoleArn - The AWS Identity and Access Management (IAM) role that AWS IoT Things
Graph assumes during flow execution in a cloud deployment. This role
must have read and write permissionss to AWS Lambda and AWS IoT and to
any other AWS services that the flow uses.
$sel:s3BucketName:SystemInstanceDescription', systemInstanceDescription_s3BucketName - The Amazon Simple Storage Service bucket where information about a
system instance is stored.
systemInstanceDescription_summary :: Lens' SystemInstanceDescription (Maybe SystemInstanceSummary) Source #
An object that contains summary information about a system instance.
systemInstanceDescription_metricsConfiguration :: Lens' SystemInstanceDescription (Maybe MetricsConfiguration) Source #
Undocumented member.
systemInstanceDescription_validatedDependencyRevisions :: Lens' SystemInstanceDescription (Maybe [DependencyRevision]) Source #
A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
systemInstanceDescription_definition :: Lens' SystemInstanceDescription (Maybe DefinitionDocument) Source #
Undocumented member.
systemInstanceDescription_validatedNamespaceVersion :: Lens' SystemInstanceDescription (Maybe Integer) Source #
The version of the user's namespace against which the system instance was validated.
systemInstanceDescription_flowActionsRoleArn :: Lens' SystemInstanceDescription (Maybe Text) Source #
The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
systemInstanceDescription_s3BucketName :: Lens' SystemInstanceDescription (Maybe Text) Source #
The Amazon Simple Storage Service bucket where information about a system instance is stored.
SystemInstanceFilter
data SystemInstanceFilter Source #
An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.
See: newSystemInstanceFilter smart constructor.
Constructors
| SystemInstanceFilter' | |
Instances
newSystemInstanceFilter :: SystemInstanceFilter Source #
Create a value of SystemInstanceFilter 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:value:SystemInstanceFilter', systemInstanceFilter_value - An array of string values for the search filter field. Multiple values
function as AND criteria in the search.
$sel:name:SystemInstanceFilter', systemInstanceFilter_name - The name of the search filter field.
systemInstanceFilter_value :: Lens' SystemInstanceFilter (Maybe [Text]) Source #
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
systemInstanceFilter_name :: Lens' SystemInstanceFilter (Maybe SystemInstanceFilterName) Source #
The name of the search filter field.
SystemInstanceSummary
data SystemInstanceSummary Source #
An object that contains summary information about a system instance.
See: newSystemInstanceSummary smart constructor.
Constructors
| SystemInstanceSummary' | |
Fields
| |
Instances
newSystemInstanceSummary :: SystemInstanceSummary Source #
Create a value of SystemInstanceSummary 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:SystemInstanceSummary', systemInstanceSummary_status - The status of the system instance.
$sel:greengrassGroupName:SystemInstanceSummary', systemInstanceSummary_greengrassGroupName - The ID of the Greengrass group where the system instance is deployed.
$sel:arn:SystemInstanceSummary', systemInstanceSummary_arn - The ARN of the system instance.
$sel:createdAt:SystemInstanceSummary', systemInstanceSummary_createdAt - The date when the system instance was created.
$sel:greengrassGroupId:SystemInstanceSummary', systemInstanceSummary_greengrassGroupId - The ID of the Greengrass group where the system instance is deployed.
$sel:greengrassGroupVersionId:SystemInstanceSummary', systemInstanceSummary_greengrassGroupVersionId - The version of the Greengrass group where the system instance is
deployed.
$sel:id:SystemInstanceSummary', systemInstanceSummary_id - The ID of the system instance.
$sel:updatedAt:SystemInstanceSummary', systemInstanceSummary_updatedAt - The date and time when the system instance was last updated.
$sel:target:SystemInstanceSummary', systemInstanceSummary_target - The target of the system instance.
systemInstanceSummary_status :: Lens' SystemInstanceSummary (Maybe SystemInstanceDeploymentStatus) Source #
The status of the system instance.
systemInstanceSummary_greengrassGroupName :: Lens' SystemInstanceSummary (Maybe Text) Source #
The ID of the Greengrass group where the system instance is deployed.
systemInstanceSummary_arn :: Lens' SystemInstanceSummary (Maybe Text) Source #
The ARN of the system instance.
systemInstanceSummary_createdAt :: Lens' SystemInstanceSummary (Maybe UTCTime) Source #
The date when the system instance was created.
systemInstanceSummary_greengrassGroupId :: Lens' SystemInstanceSummary (Maybe Text) Source #
The ID of the Greengrass group where the system instance is deployed.
systemInstanceSummary_greengrassGroupVersionId :: Lens' SystemInstanceSummary (Maybe Text) Source #
The version of the Greengrass group where the system instance is deployed.
systemInstanceSummary_id :: Lens' SystemInstanceSummary (Maybe Text) Source #
The ID of the system instance.
systemInstanceSummary_updatedAt :: Lens' SystemInstanceSummary (Maybe UTCTime) Source #
The date and time when the system instance was last updated.
systemInstanceSummary_target :: Lens' SystemInstanceSummary (Maybe DeploymentTarget) Source #
The target of the system instance.
SystemTemplateDescription
data SystemTemplateDescription Source #
An object that contains a system's definition document and summary information.
See: newSystemTemplateDescription smart constructor.
Constructors
| SystemTemplateDescription' | |
Fields
| |
Instances
newSystemTemplateDescription :: SystemTemplateDescription Source #
Create a value of SystemTemplateDescription 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:summary:SystemTemplateDescription', systemTemplateDescription_summary - An object that contains summary information about a system.
$sel:definition:SystemTemplateDescription', systemTemplateDescription_definition - The definition document of a system.
$sel:validatedNamespaceVersion:SystemTemplateDescription', systemTemplateDescription_validatedNamespaceVersion - The namespace version against which the system was validated. Use this
value in your system instance.
systemTemplateDescription_summary :: Lens' SystemTemplateDescription (Maybe SystemTemplateSummary) Source #
An object that contains summary information about a system.
systemTemplateDescription_definition :: Lens' SystemTemplateDescription (Maybe DefinitionDocument) Source #
The definition document of a system.
systemTemplateDescription_validatedNamespaceVersion :: Lens' SystemTemplateDescription (Maybe Integer) Source #
The namespace version against which the system was validated. Use this value in your system instance.
SystemTemplateFilter
data SystemTemplateFilter Source #
An object that filters a system search.
See: newSystemTemplateFilter smart constructor.
Constructors
| SystemTemplateFilter' | |
Fields
| |
Instances
newSystemTemplateFilter Source #
Create a value of SystemTemplateFilter 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:name:SystemTemplateFilter', systemTemplateFilter_name - The name of the system search filter field.
$sel:value:SystemTemplateFilter', systemTemplateFilter_value - An array of string values for the search filter field. Multiple values
function as AND criteria in the search.
systemTemplateFilter_name :: Lens' SystemTemplateFilter SystemTemplateFilterName Source #
The name of the system search filter field.
systemTemplateFilter_value :: Lens' SystemTemplateFilter [Text] Source #
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
SystemTemplateSummary
data SystemTemplateSummary Source #
An object that contains information about a system.
See: newSystemTemplateSummary smart constructor.
Constructors
| SystemTemplateSummary' | |
Instances
newSystemTemplateSummary :: SystemTemplateSummary Source #
Create a value of SystemTemplateSummary 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:arn:SystemTemplateSummary', systemTemplateSummary_arn - The ARN of the system.
$sel:createdAt:SystemTemplateSummary', systemTemplateSummary_createdAt - The date when the system was created.
$sel:revisionNumber:SystemTemplateSummary', systemTemplateSummary_revisionNumber - The revision number of the system.
$sel:id:SystemTemplateSummary', systemTemplateSummary_id - The ID of the system.
systemTemplateSummary_arn :: Lens' SystemTemplateSummary (Maybe Text) Source #
The ARN of the system.
systemTemplateSummary_createdAt :: Lens' SystemTemplateSummary (Maybe UTCTime) Source #
The date when the system was created.
systemTemplateSummary_revisionNumber :: Lens' SystemTemplateSummary (Maybe Integer) Source #
The revision number of the system.
systemTemplateSummary_id :: Lens' SystemTemplateSummary (Maybe Text) Source #
The ID of the system.
Tag
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTThingsGraph.Types.Tag" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The required name of the tag. The string value can be from 1 to 128
Unicode characters in length.
$sel:value:Tag', tag_value - The optional value of the tag. The string value can be from 1 to 256
Unicode characters in length.
tag_key :: Lens' Tag Text Source #
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.
tag_value :: Lens' Tag Text Source #
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.
Thing
An AWS IoT thing.
See: newThing smart constructor.
Constructors
| Thing' | |
Instances
| Eq Thing Source # | |
| Read Thing Source # | |
| Show Thing Source # | |
| Generic Thing Source # | |
| NFData Thing Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Thing | |
| Hashable Thing Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Thing | |
| FromJSON Thing Source # | |
| type Rep Thing Source # | |
Defined in Amazonka.IoTThingsGraph.Types.Thing type Rep Thing = D1 ('MetaData "Thing" "Amazonka.IoTThingsGraph.Types.Thing" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "Thing'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Thing 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:thingArn:Thing', thing_thingArn - The ARN of the thing.
$sel:thingName:Thing', thing_thingName - The name of the thing.