| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- GetFlowTemplate
- UpdateSystemTemplate
- DeleteSystemTemplate
- DeprecateFlowTemplate
- DeploySystemInstance
- SearchFlowTemplates (Paginated)
- DeleteNamespace
- GetSystemInstance
- ListFlowExecutionMessages (Paginated)
- ListTagsForResource (Paginated)
- SearchFlowExecutions (Paginated)
- DeleteSystemInstance
- CreateSystemInstance
- DeprecateSystemTemplate
- GetSystemTemplateRevisions (Paginated)
- SearchEntities (Paginated)
- DeleteFlowTemplate
- UpdateFlowTemplate
- GetSystemTemplate
- SearchSystemInstances (Paginated)
- GetUploadStatus
- CreateSystemTemplate
- UndeploySystemInstance
- GetFlowTemplateRevisions (Paginated)
- GetNamespaceDeletionStatus
- AssociateEntityToThing
- SearchSystemTemplates (Paginated)
- TagResource
- UntagResource
- GetEntities
- DescribeNamespace
- CreateFlowTemplate
- UploadEntityDefinitions
- DissociateEntityFromThing
- SearchThings (Paginated)
- Types
- 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
Derived from API version 2018-09-06 of the AWS service descriptions, licensed under Apache 2.0.
AWS IoT Things Graph
AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.
For more information about how AWS IoT Things Graph works, see the User Guide.
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
- data GetFlowTemplate = GetFlowTemplate' (Maybe Integer) Text
- newGetFlowTemplate :: Text -> GetFlowTemplate
- data GetFlowTemplateResponse = GetFlowTemplateResponse' (Maybe FlowTemplateDescription) Int
- newGetFlowTemplateResponse :: Int -> GetFlowTemplateResponse
- data UpdateSystemTemplate = UpdateSystemTemplate' (Maybe Integer) Text DefinitionDocument
- newUpdateSystemTemplate :: Text -> DefinitionDocument -> UpdateSystemTemplate
- data UpdateSystemTemplateResponse = UpdateSystemTemplateResponse' (Maybe SystemTemplateSummary) Int
- newUpdateSystemTemplateResponse :: Int -> UpdateSystemTemplateResponse
- data DeleteSystemTemplate = DeleteSystemTemplate' Text
- newDeleteSystemTemplate :: Text -> DeleteSystemTemplate
- data DeleteSystemTemplateResponse = DeleteSystemTemplateResponse' Int
- newDeleteSystemTemplateResponse :: Int -> DeleteSystemTemplateResponse
- data DeprecateFlowTemplate = DeprecateFlowTemplate' Text
- newDeprecateFlowTemplate :: Text -> DeprecateFlowTemplate
- data DeprecateFlowTemplateResponse = DeprecateFlowTemplateResponse' Int
- newDeprecateFlowTemplateResponse :: Int -> DeprecateFlowTemplateResponse
- data DeploySystemInstance = DeploySystemInstance' (Maybe Text)
- newDeploySystemInstance :: DeploySystemInstance
- data DeploySystemInstanceResponse = DeploySystemInstanceResponse' (Maybe Text) Int SystemInstanceSummary
- newDeploySystemInstanceResponse :: Int -> SystemInstanceSummary -> DeploySystemInstanceResponse
- data SearchFlowTemplates = SearchFlowTemplates' (Maybe [FlowTemplateFilter]) (Maybe Text) (Maybe Natural)
- newSearchFlowTemplates :: SearchFlowTemplates
- data SearchFlowTemplatesResponse = SearchFlowTemplatesResponse' (Maybe Text) (Maybe [FlowTemplateSummary]) Int
- newSearchFlowTemplatesResponse :: Int -> SearchFlowTemplatesResponse
- data DeleteNamespace = DeleteNamespace' {
- newDeleteNamespace :: DeleteNamespace
- data DeleteNamespaceResponse = DeleteNamespaceResponse' (Maybe Text) (Maybe Text) Int
- newDeleteNamespaceResponse :: Int -> DeleteNamespaceResponse
- data GetSystemInstance = GetSystemInstance' Text
- newGetSystemInstance :: Text -> GetSystemInstance
- data GetSystemInstanceResponse = GetSystemInstanceResponse' (Maybe SystemInstanceDescription) Int
- newGetSystemInstanceResponse :: Int -> GetSystemInstanceResponse
- data ListFlowExecutionMessages = ListFlowExecutionMessages' (Maybe Text) (Maybe Natural) Text
- newListFlowExecutionMessages :: Text -> ListFlowExecutionMessages
- data ListFlowExecutionMessagesResponse = ListFlowExecutionMessagesResponse' (Maybe Text) (Maybe [FlowExecutionMessage]) Int
- newListFlowExecutionMessagesResponse :: Int -> ListFlowExecutionMessagesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe Natural) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data SearchFlowExecutions = SearchFlowExecutions' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) Text
- newSearchFlowExecutions :: Text -> SearchFlowExecutions
- data SearchFlowExecutionsResponse = SearchFlowExecutionsResponse' (Maybe Text) (Maybe [FlowExecutionSummary]) Int
- newSearchFlowExecutionsResponse :: Int -> SearchFlowExecutionsResponse
- data DeleteSystemInstance = DeleteSystemInstance' (Maybe Text)
- newDeleteSystemInstance :: DeleteSystemInstance
- data DeleteSystemInstanceResponse = DeleteSystemInstanceResponse' Int
- newDeleteSystemInstanceResponse :: Int -> DeleteSystemInstanceResponse
- data CreateSystemInstance = CreateSystemInstance' (Maybe MetricsConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) DefinitionDocument DeploymentTarget
- newCreateSystemInstance :: DefinitionDocument -> DeploymentTarget -> CreateSystemInstance
- data CreateSystemInstanceResponse = CreateSystemInstanceResponse' (Maybe SystemInstanceSummary) Int
- newCreateSystemInstanceResponse :: Int -> CreateSystemInstanceResponse
- data DeprecateSystemTemplate = DeprecateSystemTemplate' Text
- newDeprecateSystemTemplate :: Text -> DeprecateSystemTemplate
- data DeprecateSystemTemplateResponse = DeprecateSystemTemplateResponse' Int
- newDeprecateSystemTemplateResponse :: Int -> DeprecateSystemTemplateResponse
- data GetSystemTemplateRevisions = GetSystemTemplateRevisions' (Maybe Text) (Maybe Natural) Text
- newGetSystemTemplateRevisions :: Text -> GetSystemTemplateRevisions
- data GetSystemTemplateRevisionsResponse = GetSystemTemplateRevisionsResponse' (Maybe Text) (Maybe [SystemTemplateSummary]) Int
- newGetSystemTemplateRevisionsResponse :: Int -> GetSystemTemplateRevisionsResponse
- data SearchEntities = SearchEntities' (Maybe [EntityFilter]) (Maybe Integer) (Maybe Text) (Maybe Natural) [EntityType]
- newSearchEntities :: SearchEntities
- data SearchEntitiesResponse = SearchEntitiesResponse' (Maybe Text) (Maybe [EntityDescription]) Int
- newSearchEntitiesResponse :: Int -> SearchEntitiesResponse
- data DeleteFlowTemplate = DeleteFlowTemplate' Text
- newDeleteFlowTemplate :: Text -> DeleteFlowTemplate
- data DeleteFlowTemplateResponse = DeleteFlowTemplateResponse' Int
- newDeleteFlowTemplateResponse :: Int -> DeleteFlowTemplateResponse
- data UpdateFlowTemplate = UpdateFlowTemplate' (Maybe Integer) Text DefinitionDocument
- newUpdateFlowTemplate :: Text -> DefinitionDocument -> UpdateFlowTemplate
- data UpdateFlowTemplateResponse = UpdateFlowTemplateResponse' (Maybe FlowTemplateSummary) Int
- newUpdateFlowTemplateResponse :: Int -> UpdateFlowTemplateResponse
- data GetSystemTemplate = GetSystemTemplate' (Maybe Integer) Text
- newGetSystemTemplate :: Text -> GetSystemTemplate
- data GetSystemTemplateResponse = GetSystemTemplateResponse' (Maybe SystemTemplateDescription) Int
- newGetSystemTemplateResponse :: Int -> GetSystemTemplateResponse
- data SearchSystemInstances = SearchSystemInstances' (Maybe [SystemInstanceFilter]) (Maybe Text) (Maybe Natural)
- newSearchSystemInstances :: SearchSystemInstances
- data SearchSystemInstancesResponse = SearchSystemInstancesResponse' (Maybe Text) (Maybe [SystemInstanceSummary]) Int
- newSearchSystemInstancesResponse :: Int -> SearchSystemInstancesResponse
- data GetUploadStatus = GetUploadStatus' Text
- newGetUploadStatus :: Text -> GetUploadStatus
- data GetUploadStatusResponse = GetUploadStatusResponse' (Maybe [Text]) (Maybe Text) (Maybe Integer) (Maybe Text) Int Text UploadStatus POSIX
- newGetUploadStatusResponse :: Int -> Text -> UploadStatus -> UTCTime -> GetUploadStatusResponse
- data CreateSystemTemplate = CreateSystemTemplate' (Maybe Integer) DefinitionDocument
- newCreateSystemTemplate :: DefinitionDocument -> CreateSystemTemplate
- data CreateSystemTemplateResponse = CreateSystemTemplateResponse' (Maybe SystemTemplateSummary) Int
- newCreateSystemTemplateResponse :: Int -> CreateSystemTemplateResponse
- data UndeploySystemInstance = UndeploySystemInstance' (Maybe Text)
- newUndeploySystemInstance :: UndeploySystemInstance
- data UndeploySystemInstanceResponse = UndeploySystemInstanceResponse' (Maybe SystemInstanceSummary) Int
- newUndeploySystemInstanceResponse :: Int -> UndeploySystemInstanceResponse
- data GetFlowTemplateRevisions = GetFlowTemplateRevisions' (Maybe Text) (Maybe Natural) Text
- newGetFlowTemplateRevisions :: Text -> GetFlowTemplateRevisions
- data GetFlowTemplateRevisionsResponse = GetFlowTemplateRevisionsResponse' (Maybe Text) (Maybe [FlowTemplateSummary]) Int
- newGetFlowTemplateRevisionsResponse :: Int -> GetFlowTemplateRevisionsResponse
- data GetNamespaceDeletionStatus = GetNamespaceDeletionStatus' {
- newGetNamespaceDeletionStatus :: GetNamespaceDeletionStatus
- data GetNamespaceDeletionStatusResponse = GetNamespaceDeletionStatusResponse' (Maybe NamespaceDeletionStatus) (Maybe Text) (Maybe Text) (Maybe NamespaceDeletionStatusErrorCodes) (Maybe Text) Int
- newGetNamespaceDeletionStatusResponse :: Int -> GetNamespaceDeletionStatusResponse
- data AssociateEntityToThing = AssociateEntityToThing' (Maybe Integer) Text Text
- newAssociateEntityToThing :: Text -> Text -> AssociateEntityToThing
- data AssociateEntityToThingResponse = AssociateEntityToThingResponse' Int
- newAssociateEntityToThingResponse :: Int -> AssociateEntityToThingResponse
- data SearchSystemTemplates = SearchSystemTemplates' (Maybe [SystemTemplateFilter]) (Maybe Text) (Maybe Natural)
- newSearchSystemTemplates :: SearchSystemTemplates
- data SearchSystemTemplatesResponse = SearchSystemTemplatesResponse' (Maybe Text) (Maybe [SystemTemplateSummary]) Int
- newSearchSystemTemplatesResponse :: Int -> SearchSystemTemplatesResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetEntities = GetEntities' (Maybe Integer) [Text]
- newGetEntities :: GetEntities
- data GetEntitiesResponse = GetEntitiesResponse' (Maybe [EntityDescription]) Int
- newGetEntitiesResponse :: Int -> GetEntitiesResponse
- data DescribeNamespace = DescribeNamespace' (Maybe Text)
- newDescribeNamespace :: DescribeNamespace
- data DescribeNamespaceResponse = DescribeNamespaceResponse' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) Int
- newDescribeNamespaceResponse :: Int -> DescribeNamespaceResponse
- data CreateFlowTemplate = CreateFlowTemplate' (Maybe Integer) DefinitionDocument
- newCreateFlowTemplate :: DefinitionDocument -> CreateFlowTemplate
- data CreateFlowTemplateResponse = CreateFlowTemplateResponse' (Maybe FlowTemplateSummary) Int
- newCreateFlowTemplateResponse :: Int -> CreateFlowTemplateResponse
- data UploadEntityDefinitions = UploadEntityDefinitions' (Maybe Bool) (Maybe Bool) (Maybe DefinitionDocument)
- newUploadEntityDefinitions :: UploadEntityDefinitions
- data UploadEntityDefinitionsResponse = UploadEntityDefinitionsResponse' Int Text
- newUploadEntityDefinitionsResponse :: Int -> Text -> UploadEntityDefinitionsResponse
- data DissociateEntityFromThing = DissociateEntityFromThing' Text EntityType
- newDissociateEntityFromThing :: Text -> EntityType -> DissociateEntityFromThing
- data DissociateEntityFromThingResponse = DissociateEntityFromThingResponse' Int
- newDissociateEntityFromThingResponse :: Int -> DissociateEntityFromThingResponse
- data SearchThings = SearchThings' (Maybe Integer) (Maybe Text) (Maybe Natural) Text
- newSearchThings :: Text -> SearchThings
- data SearchThingsResponse = SearchThingsResponse' (Maybe Text) (Maybe [Thing]) Int
- newSearchThingsResponse :: Int -> SearchThingsResponse
- 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' DefinitionLanguage Text
- newDefinitionDocument :: DefinitionLanguage -> Text -> DefinitionDocument
- data DependencyRevision = DependencyRevision' (Maybe Integer) (Maybe Text)
- newDependencyRevision :: DependencyRevision
- data EntityDescription = EntityDescription' (Maybe Text) (Maybe POSIX) (Maybe DefinitionDocument) (Maybe Text) (Maybe EntityType)
- newEntityDescription :: EntityDescription
- data EntityFilter = EntityFilter' (Maybe [Text]) (Maybe EntityFilterName)
- newEntityFilter :: EntityFilter
- data FlowExecutionMessage = FlowExecutionMessage' (Maybe Text) (Maybe FlowExecutionEventType) (Maybe POSIX) (Maybe Text)
- newFlowExecutionMessage :: FlowExecutionMessage
- data FlowExecutionSummary = FlowExecutionSummary' (Maybe FlowExecutionStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newFlowExecutionSummary :: FlowExecutionSummary
- data FlowTemplateDescription = FlowTemplateDescription' (Maybe FlowTemplateSummary) (Maybe DefinitionDocument) (Maybe Integer)
- newFlowTemplateDescription :: FlowTemplateDescription
- data FlowTemplateFilter = FlowTemplateFilter' FlowTemplateFilterName [Text]
- newFlowTemplateFilter :: FlowTemplateFilterName -> FlowTemplateFilter
- data FlowTemplateSummary = FlowTemplateSummary' (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text)
- newFlowTemplateSummary :: FlowTemplateSummary
- data MetricsConfiguration = MetricsConfiguration' (Maybe Bool) (Maybe Text)
- newMetricsConfiguration :: MetricsConfiguration
- data SystemInstanceDescription = SystemInstanceDescription' (Maybe SystemInstanceSummary) (Maybe MetricsConfiguration) (Maybe [DependencyRevision]) (Maybe DefinitionDocument) (Maybe Integer) (Maybe Text) (Maybe Text)
- newSystemInstanceDescription :: SystemInstanceDescription
- data SystemInstanceFilter = SystemInstanceFilter' (Maybe [Text]) (Maybe SystemInstanceFilterName)
- newSystemInstanceFilter :: SystemInstanceFilter
- data SystemInstanceSummary = SystemInstanceSummary' (Maybe SystemInstanceDeploymentStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe DeploymentTarget)
- newSystemInstanceSummary :: SystemInstanceSummary
- data SystemTemplateDescription = SystemTemplateDescription' (Maybe SystemTemplateSummary) (Maybe DefinitionDocument) (Maybe Integer)
- newSystemTemplateDescription :: SystemTemplateDescription
- data SystemTemplateFilter = SystemTemplateFilter' SystemTemplateFilterName [Text]
- newSystemTemplateFilter :: SystemTemplateFilterName -> SystemTemplateFilter
- data SystemTemplateSummary = SystemTemplateSummary' (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text)
- newSystemTemplateSummary :: SystemTemplateSummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Thing = Thing' (Maybe Text) (Maybe Text)
- newThing :: Thing
Service Configuration
defaultService :: Service Source #
API version 2018-09-06 of the Amazon IoT Things Graph SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTThingsGraph.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
InternalFailureException
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetFlowTemplate
data GetFlowTemplate Source #
See: newGetFlowTemplate smart constructor.
Constructors
| GetFlowTemplate' (Maybe Integer) Text |
Instances
Arguments
| :: Text | |
| -> GetFlowTemplate |
Create a value of GetFlowTemplate 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:GetFlowTemplate', getFlowTemplate_revisionNumber - The number of the workflow revision to retrieve.
$sel:id:GetFlowTemplate', getFlowTemplate_id - The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
data GetFlowTemplateResponse Source #
See: newGetFlowTemplateResponse smart constructor.
Constructors
| GetFlowTemplateResponse' (Maybe FlowTemplateDescription) Int |
Instances
newGetFlowTemplateResponse Source #
Create a value of GetFlowTemplateResponse 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:description:GetFlowTemplateResponse', getFlowTemplateResponse_description - The object that describes the specified workflow.
$sel:httpStatus:GetFlowTemplateResponse', getFlowTemplateResponse_httpStatus - The response's http status code.
UpdateSystemTemplate
data UpdateSystemTemplate Source #
See: newUpdateSystemTemplate smart constructor.
Constructors
| UpdateSystemTemplate' (Maybe Integer) Text DefinitionDocument |
Instances
newUpdateSystemTemplate Source #
Arguments
| :: Text | |
| -> DefinitionDocument | |
| -> UpdateSystemTemplate |
Create a value of UpdateSystemTemplate 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:compatibleNamespaceVersion:UpdateSystemTemplate', updateSystemTemplate_compatibleNamespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
If no value is specified, the latest version is used by default.
$sel:id:UpdateSystemTemplate', updateSystemTemplate_id - The ID of the system to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
$sel:definition:UpdateSystemTemplate', updateSystemTemplate_definition - The DefinitionDocument that contains the updated system definition.
data UpdateSystemTemplateResponse Source #
See: newUpdateSystemTemplateResponse smart constructor.
Constructors
| UpdateSystemTemplateResponse' (Maybe SystemTemplateSummary) Int |
Instances
newUpdateSystemTemplateResponse Source #
Create a value of UpdateSystemTemplateResponse 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:UpdateSystemTemplateResponse', updateSystemTemplateResponse_summary - An object containing summary information about the updated system.
$sel:httpStatus:UpdateSystemTemplateResponse', updateSystemTemplateResponse_httpStatus - The response's http status code.
DeleteSystemTemplate
data DeleteSystemTemplate Source #
See: newDeleteSystemTemplate smart constructor.
Constructors
| DeleteSystemTemplate' Text |
Instances
newDeleteSystemTemplate Source #
Arguments
| :: Text | |
| -> DeleteSystemTemplate |
Create a value of DeleteSystemTemplate 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:id:DeleteSystemTemplate', deleteSystemTemplate_id - The ID of the system to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
data DeleteSystemTemplateResponse Source #
See: newDeleteSystemTemplateResponse smart constructor.
Constructors
| DeleteSystemTemplateResponse' Int |
Instances
newDeleteSystemTemplateResponse Source #
Create a value of DeleteSystemTemplateResponse 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:httpStatus:DeleteSystemTemplateResponse', deleteSystemTemplateResponse_httpStatus - The response's http status code.
DeprecateFlowTemplate
data DeprecateFlowTemplate Source #
See: newDeprecateFlowTemplate smart constructor.
Constructors
| DeprecateFlowTemplate' Text |
Instances
newDeprecateFlowTemplate Source #
Arguments
| :: Text | |
| -> DeprecateFlowTemplate |
Create a value of DeprecateFlowTemplate 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:id:DeprecateFlowTemplate', deprecateFlowTemplate_id - The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
data DeprecateFlowTemplateResponse Source #
See: newDeprecateFlowTemplateResponse smart constructor.
Constructors
| DeprecateFlowTemplateResponse' Int |
Instances
newDeprecateFlowTemplateResponse Source #
Create a value of DeprecateFlowTemplateResponse 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:httpStatus:DeprecateFlowTemplateResponse', deprecateFlowTemplateResponse_httpStatus - The response's http status code.
DeploySystemInstance
data DeploySystemInstance Source #
See: newDeploySystemInstance smart constructor.
Constructors
| DeploySystemInstance' (Maybe Text) |
Instances
newDeploySystemInstance :: DeploySystemInstance Source #
Create a value of DeploySystemInstance 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:id:DeploySystemInstance', deploySystemInstance_id - The ID of the system instance. This value is returned by the
CreateSystemInstance action.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
data DeploySystemInstanceResponse Source #
See: newDeploySystemInstanceResponse smart constructor.
Constructors
| DeploySystemInstanceResponse' (Maybe Text) Int SystemInstanceSummary |
Instances
newDeploySystemInstanceResponse Source #
Arguments
| :: Int | |
| -> SystemInstanceSummary | |
| -> DeploySystemInstanceResponse |
Create a value of DeploySystemInstanceResponse 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:greengrassDeploymentId:DeploySystemInstanceResponse', deploySystemInstanceResponse_greengrassDeploymentId - The ID of the Greengrass deployment used to deploy the system instance.
$sel:httpStatus:DeploySystemInstanceResponse', deploySystemInstanceResponse_httpStatus - The response's http status code.
$sel:summary:DeploySystemInstanceResponse', deploySystemInstanceResponse_summary - An object that contains summary information about a system instance that
was deployed.
SearchFlowTemplates (Paginated)
data SearchFlowTemplates Source #
See: newSearchFlowTemplates smart constructor.
Constructors
| SearchFlowTemplates' (Maybe [FlowTemplateFilter]) (Maybe Text) (Maybe Natural) |
Instances
newSearchFlowTemplates :: SearchFlowTemplates Source #
Create a value of SearchFlowTemplates 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:filters:SearchFlowTemplates', searchFlowTemplates_filters - An array of objects that limit the result set. The only valid filter is
DEVICE_MODEL_ID.
$sel:nextToken:SearchFlowTemplates', searchFlowTemplates_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:SearchFlowTemplates', searchFlowTemplates_maxResults - The maximum number of results to return in the response.
data SearchFlowTemplatesResponse Source #
See: newSearchFlowTemplatesResponse smart constructor.
Constructors
| SearchFlowTemplatesResponse' (Maybe Text) (Maybe [FlowTemplateSummary]) Int |
Instances
newSearchFlowTemplatesResponse Source #
Create a value of SearchFlowTemplatesResponse 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:nextToken:SearchFlowTemplates', searchFlowTemplatesResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:SearchFlowTemplatesResponse', searchFlowTemplatesResponse_summaries - An array of objects that contain summary information about each workflow
in the result set.
$sel:httpStatus:SearchFlowTemplatesResponse', searchFlowTemplatesResponse_httpStatus - The response's http status code.
DeleteNamespace
data DeleteNamespace Source #
See: newDeleteNamespace smart constructor.
Constructors
| DeleteNamespace' | |
Instances
newDeleteNamespace :: DeleteNamespace Source #
Create a value of DeleteNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteNamespaceResponse Source #
See: newDeleteNamespaceResponse smart constructor.
Instances
newDeleteNamespaceResponse Source #
Create a value of DeleteNamespaceResponse 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:namespaceArn:DeleteNamespaceResponse', deleteNamespaceResponse_namespaceArn - The ARN of the namespace to be deleted.
$sel:namespaceName:DeleteNamespaceResponse', deleteNamespaceResponse_namespaceName - The name of the namespace to be deleted.
$sel:httpStatus:DeleteNamespaceResponse', deleteNamespaceResponse_httpStatus - The response's http status code.
GetSystemInstance
data GetSystemInstance Source #
See: newGetSystemInstance smart constructor.
Constructors
| GetSystemInstance' Text |
Instances
Arguments
| :: Text | |
| -> GetSystemInstance |
Create a value of GetSystemInstance 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:id:GetSystemInstance', getSystemInstance_id - The ID of the system deployment instance. This value is returned by
CreateSystemInstance.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
data GetSystemInstanceResponse Source #
See: newGetSystemInstanceResponse smart constructor.
Constructors
| GetSystemInstanceResponse' (Maybe SystemInstanceDescription) Int |
Instances
newGetSystemInstanceResponse Source #
Create a value of GetSystemInstanceResponse 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:description:GetSystemInstanceResponse', getSystemInstanceResponse_description - An object that describes the system instance.
$sel:httpStatus:GetSystemInstanceResponse', getSystemInstanceResponse_httpStatus - The response's http status code.
ListFlowExecutionMessages (Paginated)
data ListFlowExecutionMessages Source #
See: newListFlowExecutionMessages smart constructor.
Instances
newListFlowExecutionMessages Source #
Create a value of ListFlowExecutionMessages 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:nextToken:ListFlowExecutionMessages', listFlowExecutionMessages_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:ListFlowExecutionMessages', listFlowExecutionMessages_maxResults - The maximum number of results to return in the response.
$sel:flowExecutionId:ListFlowExecutionMessages', listFlowExecutionMessages_flowExecutionId - The ID of the flow execution.
data ListFlowExecutionMessagesResponse Source #
See: newListFlowExecutionMessagesResponse smart constructor.
Constructors
| ListFlowExecutionMessagesResponse' (Maybe Text) (Maybe [FlowExecutionMessage]) Int |
Instances
newListFlowExecutionMessagesResponse Source #
Arguments
| :: Int | |
| -> ListFlowExecutionMessagesResponse |
Create a value of ListFlowExecutionMessagesResponse 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:nextToken:ListFlowExecutionMessages', listFlowExecutionMessagesResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:messages:ListFlowExecutionMessagesResponse', listFlowExecutionMessagesResponse_messages - A list of objects that contain information about events in the specified
flow execution.
$sel:httpStatus:ListFlowExecutionMessagesResponse', listFlowExecutionMessagesResponse_httpStatus - The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:nextToken:ListTagsForResource', listTagsForResource_nextToken - The token that specifies the next page of results to return.
$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - The maximum number of tags to return.
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags are to be
returned.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:nextToken:ListTagsForResource', listTagsForResourceResponse_nextToken - The token that specifies the next page of results to return.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - List of tags returned by the ListTagsForResource operation.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
SearchFlowExecutions (Paginated)
data SearchFlowExecutions Source #
See: newSearchFlowExecutions smart constructor.
Constructors
| SearchFlowExecutions' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) Text |
Instances
newSearchFlowExecutions Source #
Create a value of SearchFlowExecutions 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:startTime:SearchFlowExecutions', searchFlowExecutions_startTime - The date and time of the earliest flow execution to return.
$sel:flowExecutionId:SearchFlowExecutions', searchFlowExecutions_flowExecutionId - The ID of a flow execution.
$sel:nextToken:SearchFlowExecutions', searchFlowExecutions_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:endTime:SearchFlowExecutions', searchFlowExecutions_endTime - The date and time of the latest flow execution to return.
$sel:maxResults:SearchFlowExecutions', searchFlowExecutions_maxResults - The maximum number of results to return in the response.
$sel:systemInstanceId:SearchFlowExecutions', searchFlowExecutions_systemInstanceId - The ID of the system instance that contains the flow.
data SearchFlowExecutionsResponse Source #
See: newSearchFlowExecutionsResponse smart constructor.
Constructors
| SearchFlowExecutionsResponse' (Maybe Text) (Maybe [FlowExecutionSummary]) Int |
Instances
newSearchFlowExecutionsResponse Source #
Create a value of SearchFlowExecutionsResponse 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:nextToken:SearchFlowExecutions', searchFlowExecutionsResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:SearchFlowExecutionsResponse', searchFlowExecutionsResponse_summaries - An array of objects that contain summary information about each workflow
execution in the result set.
$sel:httpStatus:SearchFlowExecutionsResponse', searchFlowExecutionsResponse_httpStatus - The response's http status code.
DeleteSystemInstance
data DeleteSystemInstance Source #
See: newDeleteSystemInstance smart constructor.
Constructors
| DeleteSystemInstance' (Maybe Text) |
Instances
newDeleteSystemInstance :: DeleteSystemInstance Source #
Create a value of DeleteSystemInstance 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:id:DeleteSystemInstance', deleteSystemInstance_id - The ID of the system instance to be deleted.
data DeleteSystemInstanceResponse Source #
See: newDeleteSystemInstanceResponse smart constructor.
Constructors
| DeleteSystemInstanceResponse' Int |
Instances
newDeleteSystemInstanceResponse Source #
Create a value of DeleteSystemInstanceResponse 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:httpStatus:DeleteSystemInstanceResponse', deleteSystemInstanceResponse_httpStatus - The response's http status code.
CreateSystemInstance
data CreateSystemInstance Source #
See: newCreateSystemInstance smart constructor.
Constructors
| CreateSystemInstance' (Maybe MetricsConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) DefinitionDocument DeploymentTarget |
Instances
newCreateSystemInstance Source #
Arguments
| :: DefinitionDocument | |
| -> DeploymentTarget | |
| -> CreateSystemInstance |
Create a value of CreateSystemInstance 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:metricsConfiguration:CreateSystemInstance', createSystemInstance_metricsConfiguration - Undocumented member.
$sel:greengrassGroupName:CreateSystemInstance', createSystemInstance_greengrassGroupName - The name of the Greengrass group where the system instance will be
deployed. This value is required if the value of the target parameter
is GREENGRASS.
$sel:flowActionsRoleArn:CreateSystemInstance', createSystemInstance_flowActionsRoleArn - The ARN of the IAM role that AWS IoT Things Graph will assume when it
executes the flow. This role must have read and write access to AWS
Lambda and AWS IoT and any other AWS services that the flow uses when it
executes. This value is required if the value of the target parameter
is CLOUD.
$sel:s3BucketName:CreateSystemInstance', createSystemInstance_s3BucketName - The name of the Amazon Simple Storage Service bucket that will be used
to store and deploy the system instance's resource file. This value is
required if the value of the target parameter is GREENGRASS.
$sel:tags:CreateSystemInstance', createSystemInstance_tags - Metadata, consisting of key-value pairs, that can be used to categorize
your system instances.
$sel:definition:CreateSystemInstance', createSystemInstance_definition - Undocumented member.
$sel:target:CreateSystemInstance', createSystemInstance_target - The target type of the deployment. Valid values are GREENGRASS and
CLOUD.
data CreateSystemInstanceResponse Source #
See: newCreateSystemInstanceResponse smart constructor.
Constructors
| CreateSystemInstanceResponse' (Maybe SystemInstanceSummary) Int |
Instances
newCreateSystemInstanceResponse Source #
Create a value of CreateSystemInstanceResponse 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:CreateSystemInstanceResponse', createSystemInstanceResponse_summary - The summary object that describes the new system instance.
$sel:httpStatus:CreateSystemInstanceResponse', createSystemInstanceResponse_httpStatus - The response's http status code.
DeprecateSystemTemplate
data DeprecateSystemTemplate Source #
See: newDeprecateSystemTemplate smart constructor.
Constructors
| DeprecateSystemTemplate' Text |
Instances
newDeprecateSystemTemplate Source #
Arguments
| :: Text | |
| -> DeprecateSystemTemplate |
Create a value of DeprecateSystemTemplate 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:id:DeprecateSystemTemplate', deprecateSystemTemplate_id - The ID of the system to delete.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
data DeprecateSystemTemplateResponse Source #
See: newDeprecateSystemTemplateResponse smart constructor.
Constructors
| DeprecateSystemTemplateResponse' Int |
Instances
newDeprecateSystemTemplateResponse Source #
Create a value of DeprecateSystemTemplateResponse 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:httpStatus:DeprecateSystemTemplateResponse', deprecateSystemTemplateResponse_httpStatus - The response's http status code.
GetSystemTemplateRevisions (Paginated)
data GetSystemTemplateRevisions Source #
See: newGetSystemTemplateRevisions smart constructor.
Instances
newGetSystemTemplateRevisions Source #
Create a value of GetSystemTemplateRevisions 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:nextToken:GetSystemTemplateRevisions', getSystemTemplateRevisions_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:GetSystemTemplateRevisions', getSystemTemplateRevisions_maxResults - The maximum number of results to return in the response.
$sel:id:GetSystemTemplateRevisions', getSystemTemplateRevisions_id - The ID of the system template.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
data GetSystemTemplateRevisionsResponse Source #
See: newGetSystemTemplateRevisionsResponse smart constructor.
Constructors
| GetSystemTemplateRevisionsResponse' (Maybe Text) (Maybe [SystemTemplateSummary]) Int |
Instances
newGetSystemTemplateRevisionsResponse Source #
Arguments
| :: Int | |
| -> GetSystemTemplateRevisionsResponse |
Create a value of GetSystemTemplateRevisionsResponse 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:nextToken:GetSystemTemplateRevisions', getSystemTemplateRevisionsResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:GetSystemTemplateRevisionsResponse', getSystemTemplateRevisionsResponse_summaries - An array of objects that contain summary data about the system template
revisions.
$sel:httpStatus:GetSystemTemplateRevisionsResponse', getSystemTemplateRevisionsResponse_httpStatus - The response's http status code.
SearchEntities (Paginated)
data SearchEntities Source #
See: newSearchEntities smart constructor.
Constructors
| SearchEntities' (Maybe [EntityFilter]) (Maybe Integer) (Maybe Text) (Maybe Natural) [EntityType] |
Instances
newSearchEntities :: SearchEntities Source #
Create a value of SearchEntities 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:filters:SearchEntities', searchEntities_filters - Optional filter to apply to the search. Valid filters are NAME
NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID.
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.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
$sel:namespaceVersion:SearchEntities', searchEntities_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:nextToken:SearchEntities', searchEntities_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:SearchEntities', searchEntities_maxResults - The maximum number of results to return in the response.
$sel:entityTypes:SearchEntities', searchEntities_entityTypes - The entity types for which to search.
data SearchEntitiesResponse Source #
See: newSearchEntitiesResponse smart constructor.
Constructors
| SearchEntitiesResponse' (Maybe Text) (Maybe [EntityDescription]) Int |
Instances
newSearchEntitiesResponse Source #
Create a value of SearchEntitiesResponse 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:nextToken:SearchEntities', searchEntitiesResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:descriptions:SearchEntitiesResponse', searchEntitiesResponse_descriptions - An array of descriptions for each entity returned in the search result.
$sel:httpStatus:SearchEntitiesResponse', searchEntitiesResponse_httpStatus - The response's http status code.
DeleteFlowTemplate
data DeleteFlowTemplate Source #
See: newDeleteFlowTemplate smart constructor.
Constructors
| DeleteFlowTemplate' Text |
Instances
newDeleteFlowTemplate Source #
Arguments
| :: Text | |
| -> DeleteFlowTemplate |
Create a value of DeleteFlowTemplate 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:id:DeleteFlowTemplate', deleteFlowTemplate_id - The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
data DeleteFlowTemplateResponse Source #
See: newDeleteFlowTemplateResponse smart constructor.
Constructors
| DeleteFlowTemplateResponse' Int |
Instances
newDeleteFlowTemplateResponse Source #
Create a value of DeleteFlowTemplateResponse 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:httpStatus:DeleteFlowTemplateResponse', deleteFlowTemplateResponse_httpStatus - The response's http status code.
UpdateFlowTemplate
data UpdateFlowTemplate Source #
See: newUpdateFlowTemplate smart constructor.
Constructors
| UpdateFlowTemplate' (Maybe Integer) Text DefinitionDocument |
Instances
newUpdateFlowTemplate Source #
Arguments
| :: Text | |
| -> DefinitionDocument | |
| -> UpdateFlowTemplate |
Create a value of UpdateFlowTemplate 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:compatibleNamespaceVersion:UpdateFlowTemplate', updateFlowTemplate_compatibleNamespaceVersion - The version of the user's namespace.
If no value is specified, the latest version is used by default. Use the
GetFlowTemplateRevisions if you want to find earlier revisions of the
flow to update.
$sel:id:UpdateFlowTemplate', updateFlowTemplate_id - The ID of the workflow to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
$sel:definition:UpdateFlowTemplate', updateFlowTemplate_definition - The DefinitionDocument that contains the updated workflow definition.
data UpdateFlowTemplateResponse Source #
See: newUpdateFlowTemplateResponse smart constructor.
Constructors
| UpdateFlowTemplateResponse' (Maybe FlowTemplateSummary) Int |
Instances
newUpdateFlowTemplateResponse Source #
Create a value of UpdateFlowTemplateResponse 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:UpdateFlowTemplateResponse', updateFlowTemplateResponse_summary - An object containing summary information about the updated workflow.
$sel:httpStatus:UpdateFlowTemplateResponse', updateFlowTemplateResponse_httpStatus - The response's http status code.
GetSystemTemplate
data GetSystemTemplate Source #
See: newGetSystemTemplate smart constructor.
Constructors
| GetSystemTemplate' (Maybe Integer) Text |
Instances
Arguments
| :: Text | |
| -> GetSystemTemplate |
Create a value of GetSystemTemplate 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:GetSystemTemplate', getSystemTemplate_revisionNumber - The number that specifies the revision of the system to get.
$sel:id:GetSystemTemplate', getSystemTemplate_id - The ID of the system to get. This ID must be in the user's namespace.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
data GetSystemTemplateResponse Source #
See: newGetSystemTemplateResponse smart constructor.
Constructors
| GetSystemTemplateResponse' (Maybe SystemTemplateDescription) Int |
Instances
newGetSystemTemplateResponse Source #
Create a value of GetSystemTemplateResponse 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:description:GetSystemTemplateResponse', getSystemTemplateResponse_description - An object that contains summary data about the system.
$sel:httpStatus:GetSystemTemplateResponse', getSystemTemplateResponse_httpStatus - The response's http status code.
SearchSystemInstances (Paginated)
data SearchSystemInstances Source #
See: newSearchSystemInstances smart constructor.
Constructors
| SearchSystemInstances' (Maybe [SystemInstanceFilter]) (Maybe Text) (Maybe Natural) |
Instances
newSearchSystemInstances :: SearchSystemInstances Source #
Create a value of SearchSystemInstances 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:filters:SearchSystemInstances', searchSystemInstances_filters - Optional filter to apply to the search. Valid filters are
SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
$sel:nextToken:SearchSystemInstances', searchSystemInstances_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:SearchSystemInstances', searchSystemInstances_maxResults - The maximum number of results to return in the response.
data SearchSystemInstancesResponse Source #
See: newSearchSystemInstancesResponse smart constructor.
Constructors
| SearchSystemInstancesResponse' (Maybe Text) (Maybe [SystemInstanceSummary]) Int |
Instances
newSearchSystemInstancesResponse Source #
Create a value of SearchSystemInstancesResponse 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:nextToken:SearchSystemInstances', searchSystemInstancesResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:SearchSystemInstancesResponse', searchSystemInstancesResponse_summaries - An array of objects that contain summary data abour the system instances
in the result set.
$sel:httpStatus:SearchSystemInstancesResponse', searchSystemInstancesResponse_httpStatus - The response's http status code.
GetUploadStatus
data GetUploadStatus Source #
See: newGetUploadStatus smart constructor.
Constructors
| GetUploadStatus' Text |
Instances
Arguments
| :: Text | |
| -> GetUploadStatus |
Create a value of GetUploadStatus 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:uploadId:GetUploadStatus', getUploadStatus_uploadId - The ID of the upload. This value is returned by the
UploadEntityDefinitions action.
data GetUploadStatusResponse Source #
See: newGetUploadStatusResponse smart constructor.
Constructors
| GetUploadStatusResponse' (Maybe [Text]) (Maybe Text) (Maybe Integer) (Maybe Text) Int Text UploadStatus POSIX |
Instances
newGetUploadStatusResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UploadStatus | |
| -> UTCTime | |
| -> GetUploadStatusResponse |
Create a value of GetUploadStatusResponse 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:failureReason:GetUploadStatusResponse', getUploadStatusResponse_failureReason - The reason for an upload failure.
$sel:namespaceArn:GetUploadStatusResponse', getUploadStatusResponse_namespaceArn - The ARN of the upload.
$sel:namespaceVersion:GetUploadStatusResponse', getUploadStatusResponse_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:namespaceName:GetUploadStatusResponse', getUploadStatusResponse_namespaceName - The name of the upload's namespace.
$sel:httpStatus:GetUploadStatusResponse', getUploadStatusResponse_httpStatus - The response's http status code.
$sel:uploadId:GetUploadStatus', getUploadStatusResponse_uploadId - The ID of the upload.
$sel:uploadStatus:GetUploadStatusResponse', getUploadStatusResponse_uploadStatus - The status of the upload. The initial status is IN_PROGRESS. The
response show all validation failures if the upload fails.
$sel:createdDate:GetUploadStatusResponse', getUploadStatusResponse_createdDate - The date at which the upload was created.
CreateSystemTemplate
data CreateSystemTemplate Source #
See: newCreateSystemTemplate smart constructor.
Constructors
| CreateSystemTemplate' (Maybe Integer) DefinitionDocument |
Instances
newCreateSystemTemplate Source #
Create a value of CreateSystemTemplate 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:compatibleNamespaceVersion:CreateSystemTemplate', createSystemTemplate_compatibleNamespaceVersion - The namespace version in which the system is to be created.
If no value is specified, the latest version is used by default.
$sel:definition:CreateSystemTemplate', createSystemTemplate_definition - The DefinitionDocument used to create the system.
data CreateSystemTemplateResponse Source #
See: newCreateSystemTemplateResponse smart constructor.
Constructors
| CreateSystemTemplateResponse' (Maybe SystemTemplateSummary) Int |
Instances
newCreateSystemTemplateResponse Source #
Create a value of CreateSystemTemplateResponse 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:CreateSystemTemplateResponse', createSystemTemplateResponse_summary - The summary object that describes the created system.
$sel:httpStatus:CreateSystemTemplateResponse', createSystemTemplateResponse_httpStatus - The response's http status code.
UndeploySystemInstance
data UndeploySystemInstance Source #
See: newUndeploySystemInstance smart constructor.
Constructors
| UndeploySystemInstance' (Maybe Text) |
Instances
newUndeploySystemInstance :: UndeploySystemInstance Source #
Create a value of UndeploySystemInstance 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:id:UndeploySystemInstance', undeploySystemInstance_id - The ID of the system instance to remove from its target.
data UndeploySystemInstanceResponse Source #
See: newUndeploySystemInstanceResponse smart constructor.
Constructors
| UndeploySystemInstanceResponse' (Maybe SystemInstanceSummary) Int |
Instances
newUndeploySystemInstanceResponse Source #
Create a value of UndeploySystemInstanceResponse 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:UndeploySystemInstanceResponse', undeploySystemInstanceResponse_summary - An object that contains summary information about the system instance
that was removed from its target.
$sel:httpStatus:UndeploySystemInstanceResponse', undeploySystemInstanceResponse_httpStatus - The response's http status code.
GetFlowTemplateRevisions (Paginated)
data GetFlowTemplateRevisions Source #
See: newGetFlowTemplateRevisions smart constructor.
Instances
newGetFlowTemplateRevisions Source #
Create a value of GetFlowTemplateRevisions 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:nextToken:GetFlowTemplateRevisions', getFlowTemplateRevisions_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:GetFlowTemplateRevisions', getFlowTemplateRevisions_maxResults - The maximum number of results to return in the response.
$sel:id:GetFlowTemplateRevisions', getFlowTemplateRevisions_id - The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
data GetFlowTemplateRevisionsResponse Source #
See: newGetFlowTemplateRevisionsResponse smart constructor.
Constructors
| GetFlowTemplateRevisionsResponse' (Maybe Text) (Maybe [FlowTemplateSummary]) Int |
Instances
newGetFlowTemplateRevisionsResponse Source #
Create a value of GetFlowTemplateRevisionsResponse 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:nextToken:GetFlowTemplateRevisions', getFlowTemplateRevisionsResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:GetFlowTemplateRevisionsResponse', getFlowTemplateRevisionsResponse_summaries - An array of objects that provide summary data about each revision.
$sel:httpStatus:GetFlowTemplateRevisionsResponse', getFlowTemplateRevisionsResponse_httpStatus - The response's http status code.
GetNamespaceDeletionStatus
data GetNamespaceDeletionStatus Source #
See: newGetNamespaceDeletionStatus smart constructor.
Constructors
| GetNamespaceDeletionStatus' | |
Instances
newGetNamespaceDeletionStatus :: GetNamespaceDeletionStatus Source #
Create a value of GetNamespaceDeletionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetNamespaceDeletionStatusResponse Source #
See: newGetNamespaceDeletionStatusResponse smart constructor.
Constructors
| GetNamespaceDeletionStatusResponse' (Maybe NamespaceDeletionStatus) (Maybe Text) (Maybe Text) (Maybe NamespaceDeletionStatusErrorCodes) (Maybe Text) Int |
Instances
newGetNamespaceDeletionStatusResponse Source #
Arguments
| :: Int | |
| -> GetNamespaceDeletionStatusResponse |
Create a value of GetNamespaceDeletionStatusResponse 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:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_status - The status of the deletion request.
$sel:namespaceArn:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_namespaceArn - The ARN of the namespace that is being deleted.
$sel:namespaceName:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_namespaceName - The name of the namespace that is being deleted.
$sel:errorCode:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_errorCode - An error code returned by the namespace deletion task.
$sel:errorMessage:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_errorMessage - An error code returned by the namespace deletion task.
$sel:httpStatus:GetNamespaceDeletionStatusResponse', getNamespaceDeletionStatusResponse_httpStatus - The response's http status code.
AssociateEntityToThing
data AssociateEntityToThing Source #
See: newAssociateEntityToThing smart constructor.
Constructors
| AssociateEntityToThing' (Maybe Integer) Text Text |
Instances
newAssociateEntityToThing Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateEntityToThing |
Create a value of AssociateEntityToThing 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:namespaceVersion:AssociateEntityToThing', associateEntityToThing_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:thingName:AssociateEntityToThing', associateEntityToThing_thingName - The name of the thing to which the entity is to be associated.
$sel:entityId:AssociateEntityToThing', associateEntityToThing_entityId - The ID of the device to be associated with the thing.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
data AssociateEntityToThingResponse Source #
See: newAssociateEntityToThingResponse smart constructor.
Constructors
| AssociateEntityToThingResponse' Int |
Instances
newAssociateEntityToThingResponse Source #
Create a value of AssociateEntityToThingResponse 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:httpStatus:AssociateEntityToThingResponse', associateEntityToThingResponse_httpStatus - The response's http status code.
SearchSystemTemplates (Paginated)
data SearchSystemTemplates Source #
See: newSearchSystemTemplates smart constructor.
Constructors
| SearchSystemTemplates' (Maybe [SystemTemplateFilter]) (Maybe Text) (Maybe Natural) |
Instances
newSearchSystemTemplates :: SearchSystemTemplates Source #
Create a value of SearchSystemTemplates 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:filters:SearchSystemTemplates', searchSystemTemplates_filters - An array of filters that limit the result set. The only valid filter is
FLOW_TEMPLATE_ID.
$sel:nextToken:SearchSystemTemplates', searchSystemTemplates_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:SearchSystemTemplates', searchSystemTemplates_maxResults - The maximum number of results to return in the response.
data SearchSystemTemplatesResponse Source #
See: newSearchSystemTemplatesResponse smart constructor.
Constructors
| SearchSystemTemplatesResponse' (Maybe Text) (Maybe [SystemTemplateSummary]) Int |
Instances
newSearchSystemTemplatesResponse Source #
Create a value of SearchSystemTemplatesResponse 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:nextToken:SearchSystemTemplates', searchSystemTemplatesResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:summaries:SearchSystemTemplatesResponse', searchSystemTemplatesResponse_summaries - An array of objects that contain summary information about each system
deployment in the result set.
$sel:httpStatus:SearchSystemTemplatesResponse', searchSystemTemplatesResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags are returned.
$sel:tags:TagResource', tagResource_tags - A list of tags to add to the resource.>
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags are to be
removed.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tag key names to remove from the resource. You don't specify
the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
GetEntities
data GetEntities Source #
See: newGetEntities smart constructor.
Constructors
| GetEntities' (Maybe Integer) [Text] |
Instances
newGetEntities :: GetEntities Source #
Create a value of GetEntities 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:namespaceVersion:GetEntities', getEntities_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:ids:GetEntities', getEntities_ids - An array of entity IDs.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
data GetEntitiesResponse Source #
See: newGetEntitiesResponse smart constructor.
Constructors
| GetEntitiesResponse' (Maybe [EntityDescription]) Int |
Instances
newGetEntitiesResponse Source #
Arguments
| :: Int | |
| -> GetEntitiesResponse |
Create a value of GetEntitiesResponse 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:descriptions:GetEntitiesResponse', getEntitiesResponse_descriptions - An array of descriptions for the specified entities.
$sel:httpStatus:GetEntitiesResponse', getEntitiesResponse_httpStatus - The response's http status code.
DescribeNamespace
data DescribeNamespace Source #
See: newDescribeNamespace smart constructor.
Constructors
| DescribeNamespace' (Maybe Text) |
Instances
newDescribeNamespace :: DescribeNamespace Source #
Create a value of DescribeNamespace 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:namespaceName:DescribeNamespace', describeNamespace_namespaceName - The name of the user's namespace. Set this to aws to get the public
namespace.
data DescribeNamespaceResponse Source #
See: newDescribeNamespaceResponse smart constructor.
Constructors
| DescribeNamespaceResponse' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeNamespaceResponse Source #
Create a value of DescribeNamespaceResponse 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:namespaceArn:DescribeNamespaceResponse', describeNamespaceResponse_namespaceArn - The ARN of the namespace.
$sel:trackingNamespaceVersion:DescribeNamespaceResponse', describeNamespaceResponse_trackingNamespaceVersion - The version of the public namespace that the latest version is tracking.
$sel:namespaceVersion:DescribeNamespaceResponse', describeNamespaceResponse_namespaceVersion - The version of the user's namespace to describe.
$sel:namespaceName:DescribeNamespace', describeNamespaceResponse_namespaceName - The name of the namespace.
$sel:trackingNamespaceName:DescribeNamespaceResponse', describeNamespaceResponse_trackingNamespaceName - The name of the public namespace that the latest namespace version is
tracking.
$sel:httpStatus:DescribeNamespaceResponse', describeNamespaceResponse_httpStatus - The response's http status code.
CreateFlowTemplate
data CreateFlowTemplate Source #
See: newCreateFlowTemplate smart constructor.
Constructors
| CreateFlowTemplate' (Maybe Integer) DefinitionDocument |
Instances
newCreateFlowTemplate Source #
Create a value of CreateFlowTemplate 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:compatibleNamespaceVersion:CreateFlowTemplate', createFlowTemplate_compatibleNamespaceVersion - The namespace version in which the workflow is to be created.
If no value is specified, the latest version is used by default.
$sel:definition:CreateFlowTemplate', createFlowTemplate_definition - The workflow DefinitionDocument.
data CreateFlowTemplateResponse Source #
See: newCreateFlowTemplateResponse smart constructor.
Constructors
| CreateFlowTemplateResponse' (Maybe FlowTemplateSummary) Int |
Instances
newCreateFlowTemplateResponse Source #
Create a value of CreateFlowTemplateResponse 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:CreateFlowTemplateResponse', createFlowTemplateResponse_summary - The summary object that describes the created workflow.
$sel:httpStatus:CreateFlowTemplateResponse', createFlowTemplateResponse_httpStatus - The response's http status code.
UploadEntityDefinitions
data UploadEntityDefinitions Source #
See: newUploadEntityDefinitions smart constructor.
Constructors
| UploadEntityDefinitions' (Maybe Bool) (Maybe Bool) (Maybe DefinitionDocument) |
Instances
newUploadEntityDefinitions :: UploadEntityDefinitions Source #
Create a value of UploadEntityDefinitions 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:syncWithPublicNamespace:UploadEntityDefinitions', uploadEntityDefinitions_syncWithPublicNamespace - A Boolean that specifies whether to synchronize with the latest version
of the public namespace. If set to true, the upload will create a new
namespace version.
$sel:deprecateExistingEntities:UploadEntityDefinitions', uploadEntityDefinitions_deprecateExistingEntities - A Boolean that specifies whether to deprecate all entities in the latest
version before uploading the new DefinitionDocument. If set to true,
the upload will create a new namespace version.
$sel:document:UploadEntityDefinitions', uploadEntityDefinitions_document - The DefinitionDocument that defines the updated entities.
data UploadEntityDefinitionsResponse Source #
See: newUploadEntityDefinitionsResponse smart constructor.
Constructors
| UploadEntityDefinitionsResponse' Int Text |
Instances
newUploadEntityDefinitionsResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UploadEntityDefinitionsResponse |
Create a value of UploadEntityDefinitionsResponse 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:httpStatus:UploadEntityDefinitionsResponse', uploadEntityDefinitionsResponse_httpStatus - The response's http status code.
$sel:uploadId:UploadEntityDefinitionsResponse', uploadEntityDefinitionsResponse_uploadId - The ID that specifies the upload action. You can use this to track the
status of the upload.
DissociateEntityFromThing
data DissociateEntityFromThing Source #
See: newDissociateEntityFromThing smart constructor.
Constructors
| DissociateEntityFromThing' Text EntityType |
Instances
newDissociateEntityFromThing Source #
Arguments
| :: Text | |
| -> EntityType | |
| -> DissociateEntityFromThing |
Create a value of DissociateEntityFromThing 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:thingName:DissociateEntityFromThing', dissociateEntityFromThing_thingName - The name of the thing to disassociate.
$sel:entityType:DissociateEntityFromThing', dissociateEntityFromThing_entityType - The entity type from which to disassociate the thing.
data DissociateEntityFromThingResponse Source #
See: newDissociateEntityFromThingResponse smart constructor.
Constructors
| DissociateEntityFromThingResponse' Int |
Instances
newDissociateEntityFromThingResponse Source #
Arguments
| :: Int | |
| -> DissociateEntityFromThingResponse |
Create a value of DissociateEntityFromThingResponse 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:httpStatus:DissociateEntityFromThingResponse', dissociateEntityFromThingResponse_httpStatus - The response's http status code.
SearchThings (Paginated)
data SearchThings Source #
See: newSearchThings smart constructor.
Instances
Arguments
| :: Text | |
| -> SearchThings |
Create a value of SearchThings 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:namespaceVersion:SearchThings', searchThings_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:nextToken:SearchThings', searchThings_nextToken - The string that specifies the next page of results. Use this when
you're paginating results.
$sel:maxResults:SearchThings', searchThings_maxResults - The maximum number of results to return in the response.
$sel:entityId:SearchThings', searchThings_entityId - The ID of the entity to which the things are associated.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
data SearchThingsResponse Source #
See: newSearchThingsResponse smart constructor.
Instances
newSearchThingsResponse Source #
Arguments
| :: Int | |
| -> SearchThingsResponse |
Create a value of SearchThingsResponse 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:nextToken:SearchThings', searchThingsResponse_nextToken - The string to specify as nextToken when you request the next page of
results.
$sel:things:SearchThingsResponse', searchThingsResponse_things - An array of things in the result set.
$sel:httpStatus:SearchThingsResponse', searchThingsResponse_httpStatus - The response's http status code.
Types
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' DefinitionLanguage Text |
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.
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' (Maybe Integer) (Maybe Text) |
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.
EntityDescription
data EntityDescription Source #
Describes the properties of an entity.
See: newEntityDescription smart constructor.
Constructors
| EntityDescription' (Maybe Text) (Maybe POSIX) (Maybe DefinitionDocument) (Maybe Text) (Maybe EntityType) |
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.
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' (Maybe [Text]) (Maybe EntityFilterName) |
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.
FlowExecutionMessage
data FlowExecutionMessage Source #
An object that contains information about a flow event.
See: newFlowExecutionMessage smart constructor.
Constructors
| FlowExecutionMessage' (Maybe Text) (Maybe FlowExecutionEventType) (Maybe POSIX) (Maybe Text) |
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.
FlowExecutionSummary
data FlowExecutionSummary Source #
An object that contains summary information about a flow execution.
See: newFlowExecutionSummary smart constructor.
Constructors
| FlowExecutionSummary' (Maybe FlowExecutionStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) |
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.
FlowTemplateDescription
data FlowTemplateDescription Source #
An object that contains a workflow's definition and summary information.
See: newFlowTemplateDescription smart constructor.
Constructors
| FlowTemplateDescription' (Maybe FlowTemplateSummary) (Maybe DefinitionDocument) (Maybe Integer) |
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.
FlowTemplateFilter
data FlowTemplateFilter Source #
An object that filters a workflow search.
See: newFlowTemplateFilter smart constructor.
Constructors
| FlowTemplateFilter' FlowTemplateFilterName [Text] |
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.
FlowTemplateSummary
data FlowTemplateSummary Source #
An object that contains summary information about a workflow.
See: newFlowTemplateSummary smart constructor.
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.
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' (Maybe Bool) (Maybe Text) |
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.
SystemInstanceDescription
data SystemInstanceDescription Source #
An object that contains a system instance definition and summary information.
See: newSystemInstanceDescription smart constructor.
Constructors
| SystemInstanceDescription' (Maybe SystemInstanceSummary) (Maybe MetricsConfiguration) (Maybe [DependencyRevision]) (Maybe DefinitionDocument) (Maybe Integer) (Maybe Text) (Maybe Text) |
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.
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' (Maybe [Text]) (Maybe SystemInstanceFilterName) |
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.
SystemInstanceSummary
data SystemInstanceSummary Source #
An object that contains summary information about a system instance.
See: newSystemInstanceSummary smart constructor.
Constructors
| SystemInstanceSummary' (Maybe SystemInstanceDeploymentStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe DeploymentTarget) |
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.
SystemTemplateDescription
data SystemTemplateDescription Source #
An object that contains a system's definition document and summary information.
See: newSystemTemplateDescription smart constructor.
Constructors
| SystemTemplateDescription' (Maybe SystemTemplateSummary) (Maybe DefinitionDocument) (Maybe Integer) |
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.
SystemTemplateFilter
data SystemTemplateFilter Source #
An object that filters a system search.
See: newSystemTemplateFilter smart constructor.
Constructors
| SystemTemplateFilter' SystemTemplateFilterName [Text] |
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.
SystemTemplateSummary
data SystemTemplateSummary Source #
An object that contains information about a system.
See: newSystemTemplateSummary smart constructor.
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.
Tag
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
See: newTag smart constructor.
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.
Thing
An AWS IoT thing.
See: newThing smart constructor.
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.