@Generated(value="software.amazon.awssdk:codegen") public interface IoTThingsGraphClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateEntityToThingResponse |
associateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest)
Associates a device with a concrete thing that is in the user's registry.
|
default AssociateEntityToThingResponse |
associateEntityToThing(Consumer<AssociateEntityToThingRequest.Builder> associateEntityToThingRequest)
Associates a device with a concrete thing that is in the user's registry.
|
static IoTThingsGraphClientBuilder |
builder()
Create a builder that can be used to configure and create a
IoTThingsGraphClient. |
static IoTThingsGraphClient |
create()
Create a
IoTThingsGraphClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateFlowTemplateResponse |
createFlowTemplate(Consumer<CreateFlowTemplateRequest.Builder> createFlowTemplateRequest)
Creates a workflow template.
|
default CreateFlowTemplateResponse |
createFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest)
Creates a workflow template.
|
default CreateSystemInstanceResponse |
createSystemInstance(Consumer<CreateSystemInstanceRequest.Builder> createSystemInstanceRequest)
Creates a system instance.
|
default CreateSystemInstanceResponse |
createSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest)
Creates a system instance.
|
default CreateSystemTemplateResponse |
createSystemTemplate(Consumer<CreateSystemTemplateRequest.Builder> createSystemTemplateRequest)
Creates a system.
|
default CreateSystemTemplateResponse |
createSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest)
Creates a system.
|
default DeleteFlowTemplateResponse |
deleteFlowTemplate(Consumer<DeleteFlowTemplateRequest.Builder> deleteFlowTemplateRequest)
Deletes a workflow.
|
default DeleteFlowTemplateResponse |
deleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest)
Deletes a workflow.
|
default DeleteNamespaceResponse |
deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
Deletes the specified namespace.
|
default DeleteNamespaceResponse |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes the specified namespace.
|
default DeleteSystemInstanceResponse |
deleteSystemInstance(Consumer<DeleteSystemInstanceRequest.Builder> deleteSystemInstanceRequest)
Deletes a system instance.
|
default DeleteSystemInstanceResponse |
deleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest)
Deletes a system instance.
|
default DeleteSystemTemplateResponse |
deleteSystemTemplate(Consumer<DeleteSystemTemplateRequest.Builder> deleteSystemTemplateRequest)
Deletes a system.
|
default DeleteSystemTemplateResponse |
deleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest)
Deletes a system.
|
default DeploySystemInstanceResponse |
deploySystemInstance(Consumer<DeploySystemInstanceRequest.Builder> deploySystemInstanceRequest)
Greengrass and Cloud Deployments
|
default DeploySystemInstanceResponse |
deploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest)
Greengrass and Cloud Deployments
|
default DeprecateFlowTemplateResponse |
deprecateFlowTemplate(Consumer<DeprecateFlowTemplateRequest.Builder> deprecateFlowTemplateRequest)
Deprecates the specified workflow.
|
default DeprecateFlowTemplateResponse |
deprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest)
Deprecates the specified workflow.
|
default DeprecateSystemTemplateResponse |
deprecateSystemTemplate(Consumer<DeprecateSystemTemplateRequest.Builder> deprecateSystemTemplateRequest)
Deprecates the specified system.
|
default DeprecateSystemTemplateResponse |
deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest)
Deprecates the specified system.
|
default DescribeNamespaceResponse |
describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)
Gets the latest version of the user's namespace and the public version that it is tracking.
|
default DescribeNamespaceResponse |
describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Gets the latest version of the user's namespace and the public version that it is tracking.
|
default DissociateEntityFromThingResponse |
dissociateEntityFromThing(Consumer<DissociateEntityFromThingRequest.Builder> dissociateEntityFromThingRequest)
Dissociates a device entity from a concrete thing.
|
default DissociateEntityFromThingResponse |
dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest)
Dissociates a device entity from a concrete thing.
|
default GetEntitiesResponse |
getEntities(Consumer<GetEntitiesRequest.Builder> getEntitiesRequest)
Gets definitions of the specified entities.
|
default GetEntitiesResponse |
getEntities(GetEntitiesRequest getEntitiesRequest)
Gets definitions of the specified entities.
|
default GetFlowTemplateResponse |
getFlowTemplate(Consumer<GetFlowTemplateRequest.Builder> getFlowTemplateRequest)
Gets the latest version of the
DefinitionDocument and FlowTemplateSummary for the
specified workflow. |
default GetFlowTemplateResponse |
getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest)
Gets the latest version of the
DefinitionDocument and FlowTemplateSummary for the
specified workflow. |
default GetFlowTemplateRevisionsResponse |
getFlowTemplateRevisions(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest)
Gets revisions of the specified workflow.
|
default GetFlowTemplateRevisionsResponse |
getFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
Gets revisions of the specified workflow.
|
default GetFlowTemplateRevisionsIterable |
getFlowTemplateRevisionsPaginator(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest)
Gets revisions of the specified workflow.
|
default GetFlowTemplateRevisionsIterable |
getFlowTemplateRevisionsPaginator(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
Gets revisions of the specified workflow.
|
default GetNamespaceDeletionStatusResponse |
getNamespaceDeletionStatus(Consumer<GetNamespaceDeletionStatusRequest.Builder> getNamespaceDeletionStatusRequest)
Gets the status of a namespace deletion task.
|
default GetNamespaceDeletionStatusResponse |
getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest)
Gets the status of a namespace deletion task.
|
default GetSystemInstanceResponse |
getSystemInstance(Consumer<GetSystemInstanceRequest.Builder> getSystemInstanceRequest)
Gets a system instance.
|
default GetSystemInstanceResponse |
getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest)
Gets a system instance.
|
default GetSystemTemplateResponse |
getSystemTemplate(Consumer<GetSystemTemplateRequest.Builder> getSystemTemplateRequest)
Gets a system.
|
default GetSystemTemplateResponse |
getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest)
Gets a system.
|
default GetSystemTemplateRevisionsResponse |
getSystemTemplateRevisions(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest)
Gets revisions made to the specified system template.
|
default GetSystemTemplateRevisionsResponse |
getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
Gets revisions made to the specified system template.
|
default GetSystemTemplateRevisionsIterable |
getSystemTemplateRevisionsPaginator(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest)
Gets revisions made to the specified system template.
|
default GetSystemTemplateRevisionsIterable |
getSystemTemplateRevisionsPaginator(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
Gets revisions made to the specified system template.
|
default GetUploadStatusResponse |
getUploadStatus(Consumer<GetUploadStatusRequest.Builder> getUploadStatusRequest)
Gets the status of the specified upload.
|
default GetUploadStatusResponse |
getUploadStatus(GetUploadStatusRequest getUploadStatusRequest)
Gets the status of the specified upload.
|
default ListFlowExecutionMessagesResponse |
listFlowExecutionMessages(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
|
default ListFlowExecutionMessagesResponse |
listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
|
default ListFlowExecutionMessagesIterable |
listFlowExecutionMessagesPaginator(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
|
default ListFlowExecutionMessagesIterable |
listFlowExecutionMessagesPaginator(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
|
default SearchEntitiesResponse |
searchEntities(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest)
Searches for entities of the specified type.
|
default SearchEntitiesResponse |
searchEntities(SearchEntitiesRequest searchEntitiesRequest)
Searches for entities of the specified type.
|
default SearchEntitiesIterable |
searchEntitiesPaginator(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest)
Searches for entities of the specified type.
|
default SearchEntitiesIterable |
searchEntitiesPaginator(SearchEntitiesRequest searchEntitiesRequest)
Searches for entities of the specified type.
|
default SearchFlowExecutionsResponse |
searchFlowExecutions(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
|
default SearchFlowExecutionsResponse |
searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
|
default SearchFlowExecutionsIterable |
searchFlowExecutionsPaginator(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
|
default SearchFlowExecutionsIterable |
searchFlowExecutionsPaginator(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
|
default SearchFlowTemplatesResponse |
searchFlowTemplates(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest)
Searches for summary information about workflows.
|
default SearchFlowTemplatesResponse |
searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
Searches for summary information about workflows.
|
default SearchFlowTemplatesIterable |
searchFlowTemplatesPaginator(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest)
Searches for summary information about workflows.
|
default SearchFlowTemplatesIterable |
searchFlowTemplatesPaginator(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
Searches for summary information about workflows.
|
default SearchSystemInstancesResponse |
searchSystemInstances(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest)
Searches for system instances in the user's account.
|
default SearchSystemInstancesResponse |
searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest)
Searches for system instances in the user's account.
|
default SearchSystemInstancesIterable |
searchSystemInstancesPaginator(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest)
Searches for system instances in the user's account.
|
default SearchSystemInstancesIterable |
searchSystemInstancesPaginator(SearchSystemInstancesRequest searchSystemInstancesRequest)
Searches for system instances in the user's account.
|
default SearchSystemTemplatesResponse |
searchSystemTemplates(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest)
Searches for summary information about systems in the user's account.
|
default SearchSystemTemplatesResponse |
searchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
Searches for summary information about systems in the user's account.
|
default SearchSystemTemplatesIterable |
searchSystemTemplatesPaginator(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest)
Searches for summary information about systems in the user's account.
|
default SearchSystemTemplatesIterable |
searchSystemTemplatesPaginator(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
Searches for summary information about systems in the user's account.
|
default SearchThingsResponse |
searchThings(Consumer<SearchThingsRequest.Builder> searchThingsRequest)
Searches for things associated with the specified entity.
|
default SearchThingsResponse |
searchThings(SearchThingsRequest searchThingsRequest)
Searches for things associated with the specified entity.
|
default SearchThingsIterable |
searchThingsPaginator(Consumer<SearchThingsRequest.Builder> searchThingsRequest)
Searches for things associated with the specified entity.
|
default SearchThingsIterable |
searchThingsPaginator(SearchThingsRequest searchThingsRequest)
Searches for things associated with the specified entity.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Creates a tag for the specified resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Creates a tag for the specified resource.
|
default UndeploySystemInstanceResponse |
undeploySystemInstance(Consumer<UndeploySystemInstanceRequest.Builder> undeploySystemInstanceRequest)
Removes a system instance from its target (Cloud or Greengrass).
|
default UndeploySystemInstanceResponse |
undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest)
Removes a system instance from its target (Cloud or Greengrass).
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from the specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified resource.
|
default UpdateFlowTemplateResponse |
updateFlowTemplate(Consumer<UpdateFlowTemplateRequest.Builder> updateFlowTemplateRequest)
Updates the specified workflow.
|
default UpdateFlowTemplateResponse |
updateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest)
Updates the specified workflow.
|
default UpdateSystemTemplateResponse |
updateSystemTemplate(Consumer<UpdateSystemTemplateRequest.Builder> updateSystemTemplateRequest)
Updates the specified system.
|
default UpdateSystemTemplateResponse |
updateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest)
Updates the specified system.
|
default UploadEntityDefinitionsResponse |
uploadEntityDefinitions(Consumer<UploadEntityDefinitionsRequest.Builder> uploadEntityDefinitionsRequest)
Asynchronously uploads one or more entity definitions to the user's namespace.
|
default UploadEntityDefinitionsResponse |
uploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest)
Asynchronously uploads one or more entity definitions to the user's namespace.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IoTThingsGraphClient create()
IoTThingsGraphClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IoTThingsGraphClientBuilder builder()
IoTThingsGraphClient.default AssociateEntityToThingResponse associateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Associates a device with a concrete thing that is in the user's registry.
A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.
associateEntityToThingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateEntityToThingResponse associateEntityToThing(Consumer<AssociateEntityToThingRequest.Builder> associateEntityToThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Associates a device with a concrete thing that is in the user's registry.
A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.
This is a convenience which creates an instance of the AssociateEntityToThingRequest.Builder avoiding the
need to create one manually via AssociateEntityToThingRequest.builder()
associateEntityToThingRequest - A Consumer that will call methods on AssociateEntityToThingRequest.Builder to create a
request.InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFlowTemplateResponse createFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.
createFlowTemplateRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionLimitExceededExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFlowTemplateResponse createFlowTemplate(Consumer<CreateFlowTemplateRequest.Builder> createFlowTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.
This is a convenience which creates an instance of the CreateFlowTemplateRequest.Builder avoiding the
need to create one manually via CreateFlowTemplateRequest.builder()
createFlowTemplateRequest - A Consumer that will call methods on CreateFlowTemplateRequest.Builder to create a
request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionLimitExceededExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSystemInstanceResponse createSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a system instance.
This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments,
it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds
a file to the S3 bucket specified by the s3BucketName parameter. You need to call
DeploySystemInstance after running this action.
For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.
For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has
permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.
If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.
createSystemInstanceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionLimitExceededExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSystemInstanceResponse createSystemInstance(Consumer<CreateSystemInstanceRequest.Builder> createSystemInstanceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a system instance.
This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments,
it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds
a file to the S3 bucket specified by the s3BucketName parameter. You need to call
DeploySystemInstance after running this action.
For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.
For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has
permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.
If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.
This is a convenience which creates an instance of the CreateSystemInstanceRequest.Builder avoiding the
need to create one manually via CreateSystemInstanceRequest.builder()
createSystemInstanceRequest - A Consumer that will call methods on CreateSystemInstanceRequest.Builder to create a
request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionLimitExceededExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSystemTemplateResponse createSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.
createSystemTemplateRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSystemTemplateResponse createSystemTemplate(Consumer<CreateSystemTemplateRequest.Builder> createSystemTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.
This is a convenience which creates an instance of the CreateSystemTemplateRequest.Builder avoiding the
need to create one manually via CreateSystemTemplateRequest.builder()
createSystemTemplateRequest - A Consumer that will call methods on CreateSystemTemplateRequest.Builder to create a
request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFlowTemplateResponse deleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).
deleteFlowTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFlowTemplateResponse deleteFlowTemplate(Consumer<DeleteFlowTemplateRequest.Builder> deleteFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).
This is a convenience which creates an instance of the DeleteFlowTemplateRequest.Builder avoiding the
need to create one manually via DeleteFlowTemplateRequest.builder()
deleteFlowTemplateRequest - A Consumer that will call methods on DeleteFlowTemplateRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.
deleteNamespaceRequest - InternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.
This is a convenience which creates an instance of the DeleteNamespaceRequest.Builder avoiding the need
to create one manually via DeleteNamespaceRequest.builder()
deleteNamespaceRequest - A Consumer that will call methods on DeleteNamespaceRequest.Builder to create a request.InternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSystemInstanceResponse deleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
Users can create a new system instance that has the same ID as a deleted system instance.
deleteSystemInstanceRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSystemInstanceResponse deleteSystemInstance(Consumer<DeleteSystemInstanceRequest.Builder> deleteSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
Users can create a new system instance that has the same ID as a deleted system instance.
This is a convenience which creates an instance of the DeleteSystemInstanceRequest.Builder avoiding the
need to create one manually via DeleteSystemInstanceRequest.builder()
deleteSystemInstanceRequest - A Consumer that will call methods on DeleteSystemInstanceRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSystemTemplateResponse deleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.
deleteSystemTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSystemTemplateResponse deleteSystemTemplate(Consumer<DeleteSystemTemplateRequest.Builder> deleteSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.
This is a convenience which creates an instance of the DeleteSystemTemplateRequest.Builder avoiding the
need to create one manually via DeleteSystemTemplateRequest.builder()
deleteSystemTemplateRequest - A Consumer that will call methods on DeleteSystemTemplateRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeploySystemInstanceResponse deploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Greengrass and Cloud Deployments
Deploys the system instance to the target specified in CreateSystemInstance.
Greengrass Deployments
If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.
Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.
For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.
deploySystemInstanceRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeploySystemInstanceResponse deploySystemInstance(Consumer<DeploySystemInstanceRequest.Builder> deploySystemInstanceRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Greengrass and Cloud Deployments
Deploys the system instance to the target specified in CreateSystemInstance.
Greengrass Deployments
If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.
Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.
For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.
This is a convenience which creates an instance of the DeploySystemInstanceRequest.Builder avoiding the
need to create one manually via DeploySystemInstanceRequest.builder()
deploySystemInstanceRequest - A Consumer that will call methods on DeploySystemInstanceRequest.Builder to create a
request.ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeprecateFlowTemplateResponse deprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
deprecateFlowTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeprecateFlowTemplateResponse deprecateFlowTemplate(Consumer<DeprecateFlowTemplateRequest.Builder> deprecateFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
This is a convenience which creates an instance of the DeprecateFlowTemplateRequest.Builder avoiding the
need to create one manually via DeprecateFlowTemplateRequest.builder()
deprecateFlowTemplateRequest - A Consumer that will call methods on DeprecateFlowTemplateRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeprecateSystemTemplateResponse deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deprecates the specified system.
deprecateSystemTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeprecateSystemTemplateResponse deprecateSystemTemplate(Consumer<DeprecateSystemTemplateRequest.Builder> deprecateSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Deprecates the specified system.
This is a convenience which creates an instance of the DeprecateSystemTemplateRequest.Builder avoiding
the need to create one manually via DeprecateSystemTemplateRequest.builder()
deprecateSystemTemplateRequest - A Consumer that will call methods on DeprecateSystemTemplateRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeNamespaceResponse describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the latest version of the user's namespace and the public version that it is tracking.
describeNamespaceRequest - ResourceNotFoundExceptionInvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeNamespaceResponse describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the latest version of the user's namespace and the public version that it is tracking.
This is a convenience which creates an instance of the DescribeNamespaceRequest.Builder avoiding the need
to create one manually via DescribeNamespaceRequest.builder()
describeNamespaceRequest - A Consumer that will call methods on DescribeNamespaceRequest.Builder to create a request.ResourceNotFoundExceptionInvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DissociateEntityFromThingResponse dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.
dissociateEntityFromThingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DissociateEntityFromThingResponse dissociateEntityFromThing(Consumer<DissociateEntityFromThingRequest.Builder> dissociateEntityFromThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.
This is a convenience which creates an instance of the DissociateEntityFromThingRequest.Builder avoiding
the need to create one manually via DissociateEntityFromThingRequest.builder()
dissociateEntityFromThingRequest - A Consumer that will call methods on DissociateEntityFromThingRequest.Builder to create a
request.InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEntitiesResponse getEntities(GetEntitiesRequest getEntitiesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.
Properties
States
Events
Actions
Capabilities
Mappings
Devices
Device Models
Services
This action doesn't return definitions for systems, flows, and deployments.
getEntitiesRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEntitiesResponse getEntities(Consumer<GetEntitiesRequest.Builder> getEntitiesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.
Properties
States
Events
Actions
Capabilities
Mappings
Devices
Device Models
Services
This action doesn't return definitions for systems, flows, and deployments.
This is a convenience which creates an instance of the GetEntitiesRequest.Builder avoiding the need to
create one manually via GetEntitiesRequest.builder()
getEntitiesRequest - A Consumer that will call methods on GetEntitiesRequest.Builder to create a request.InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateResponse getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the
specified workflow.
getFlowTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateResponse getFlowTemplate(Consumer<GetFlowTemplateRequest.Builder> getFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the
specified workflow.
This is a convenience which creates an instance of the GetFlowTemplateRequest.Builder avoiding the need
to create one manually via GetFlowTemplateRequest.builder()
getFlowTemplateRequest - A Consumer that will call methods on GetFlowTemplateRequest.Builder to create a request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateRevisionsResponse getFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.
getFlowTemplateRevisionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateRevisionsResponse getFlowTemplateRevisions(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.
This is a convenience which creates an instance of the GetFlowTemplateRevisionsRequest.Builder avoiding
the need to create one manually via GetFlowTemplateRevisionsRequest.builder()
getFlowTemplateRevisionsRequest - A Consumer that will call methods on GetFlowTemplateRevisionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateRevisionsIterable getFlowTemplateRevisionsPaginator(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.
This is a variant of
getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client
.getFlowTemplateRevisionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest)
operation.
getFlowTemplateRevisionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFlowTemplateRevisionsIterable getFlowTemplateRevisionsPaginator(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.
This is a variant of
getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client
.getFlowTemplateRevisionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest)
operation.
This is a convenience which creates an instance of the GetFlowTemplateRevisionsRequest.Builder avoiding
the need to create one manually via GetFlowTemplateRevisionsRequest.builder()
getFlowTemplateRevisionsRequest - A Consumer that will call methods on GetFlowTemplateRevisionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamespaceDeletionStatusResponse getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the status of a namespace deletion task.
getNamespaceDeletionStatusRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamespaceDeletionStatusResponse getNamespaceDeletionStatus(Consumer<GetNamespaceDeletionStatusRequest.Builder> getNamespaceDeletionStatusRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the status of a namespace deletion task.
This is a convenience which creates an instance of the GetNamespaceDeletionStatusRequest.Builder avoiding
the need to create one manually via GetNamespaceDeletionStatusRequest.builder()
getNamespaceDeletionStatusRequest - A Consumer that will call methods on GetNamespaceDeletionStatusRequest.Builder to create a
request.InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemInstanceResponse getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets a system instance.
getSystemInstanceRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemInstanceResponse getSystemInstance(Consumer<GetSystemInstanceRequest.Builder> getSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets a system instance.
This is a convenience which creates an instance of the GetSystemInstanceRequest.Builder avoiding the need
to create one manually via GetSystemInstanceRequest.builder()
getSystemInstanceRequest - A Consumer that will call methods on GetSystemInstanceRequest.Builder to create a request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateResponse getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets a system.
getSystemTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateResponse getSystemTemplate(Consumer<GetSystemTemplateRequest.Builder> getSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets a system.
This is a convenience which creates an instance of the GetSystemTemplateRequest.Builder avoiding the need
to create one manually via GetSystemTemplateRequest.builder()
getSystemTemplateRequest - A Consumer that will call methods on GetSystemTemplateRequest.Builder to create a request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateRevisionsResponse getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.
getSystemTemplateRevisionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateRevisionsResponse getSystemTemplateRevisions(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.
This is a convenience which creates an instance of the GetSystemTemplateRevisionsRequest.Builder avoiding
the need to create one manually via GetSystemTemplateRevisionsRequest.builder()
getSystemTemplateRevisionsRequest - A Consumer that will call methods on GetSystemTemplateRevisionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateRevisionsIterable getSystemTemplateRevisionsPaginator(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.
This is a variant of
getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client
.getSystemTemplateRevisionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest)
operation.
getSystemTemplateRevisionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSystemTemplateRevisionsIterable getSystemTemplateRevisionsPaginator(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.
This is a variant of
getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client
.getSystemTemplateRevisionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest)
operation.
This is a convenience which creates an instance of the GetSystemTemplateRevisionsRequest.Builder avoiding
the need to create one manually via GetSystemTemplateRevisionsRequest.builder()
getSystemTemplateRevisionsRequest - A Consumer that will call methods on GetSystemTemplateRevisionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUploadStatusResponse getUploadStatus(GetUploadStatusRequest getUploadStatusRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the status of the specified upload.
getUploadStatusRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUploadStatusResponse getUploadStatus(Consumer<GetUploadStatusRequest.Builder> getUploadStatusRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Gets the status of the specified upload.
This is a convenience which creates an instance of the GetUploadStatusRequest.Builder avoiding the need
to create one manually via GetUploadStatusRequest.builder()
getUploadStatusRequest - A Consumer that will call methods on GetUploadStatusRequest.Builder to create a request.InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowExecutionMessagesResponse listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Returns a list of objects that contain information about events in a flow execution.
listFlowExecutionMessagesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowExecutionMessagesResponse listFlowExecutionMessages(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Returns a list of objects that contain information about events in a flow execution.
This is a convenience which creates an instance of the ListFlowExecutionMessagesRequest.Builder avoiding
the need to create one manually via ListFlowExecutionMessagesRequest.builder()
listFlowExecutionMessagesRequest - A Consumer that will call methods on ListFlowExecutionMessagesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowExecutionMessagesIterable listFlowExecutionMessagesPaginator(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Returns a list of objects that contain information about events in a flow execution.
This is a variant of
listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client
.listFlowExecutionMessagesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest)
operation.
listFlowExecutionMessagesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowExecutionMessagesIterable listFlowExecutionMessagesPaginator(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Returns a list of objects that contain information about events in a flow execution.
This is a variant of
listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client
.listFlowExecutionMessagesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest)
operation.
This is a convenience which creates an instance of the ListFlowExecutionMessagesRequest.Builder avoiding
the need to create one manually via ListFlowExecutionMessagesRequest.builder()
listFlowExecutionMessagesRequest - A Consumer that will call methods on ListFlowExecutionMessagesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Lists all tags on an AWS IoT Things Graph resource.
listTagsForResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Lists all tags on an AWS IoT Things Graph resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Lists all tags on an AWS IoT Things Graph resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Lists all tags on an AWS IoT Things Graph resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchEntitiesResponse searchEntities(SearchEntitiesRequest searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
searchEntitiesRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchEntitiesResponse searchEntities(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
This is a convenience which creates an instance of the SearchEntitiesRequest.Builder avoiding the need to
create one manually via SearchEntitiesRequest.builder()
searchEntitiesRequest - A Consumer that will call methods on SearchEntitiesRequest.Builder to create a request.InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchEntitiesIterable searchEntitiesPaginator(SearchEntitiesRequest searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
This is a variant of
searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client
.searchEntitiesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest)
operation.
searchEntitiesRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchEntitiesIterable searchEntitiesPaginator(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
This is a variant of
searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client
.searchEntitiesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest)
operation.
This is a convenience which creates an instance of the SearchEntitiesRequest.Builder avoiding the need to
create one manually via SearchEntitiesRequest.builder()
searchEntitiesRequest - A Consumer that will call methods on SearchEntitiesRequest.Builder to create a request.InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowExecutionsResponse searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for AWS IoT Things Graph workflow execution instances.
searchFlowExecutionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowExecutionsResponse searchFlowExecutions(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for AWS IoT Things Graph workflow execution instances.
This is a convenience which creates an instance of the SearchFlowExecutionsRequest.Builder avoiding the
need to create one manually via SearchFlowExecutionsRequest.builder()
searchFlowExecutionsRequest - A Consumer that will call methods on SearchFlowExecutionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowExecutionsIterable searchFlowExecutionsPaginator(SearchFlowExecutionsRequest searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for AWS IoT Things Graph workflow execution instances.
This is a variant of
searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client
.searchFlowExecutionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest)
operation.
searchFlowExecutionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowExecutionsIterable searchFlowExecutionsPaginator(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for AWS IoT Things Graph workflow execution instances.
This is a variant of
searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client
.searchFlowExecutionsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest)
operation.
This is a convenience which creates an instance of the SearchFlowExecutionsRequest.Builder avoiding the
need to create one manually via SearchFlowExecutionsRequest.builder()
searchFlowExecutionsRequest - A Consumer that will call methods on SearchFlowExecutionsRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowTemplatesResponse searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about workflows.
searchFlowTemplatesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowTemplatesResponse searchFlowTemplates(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about workflows.
This is a convenience which creates an instance of the SearchFlowTemplatesRequest.Builder avoiding the
need to create one manually via SearchFlowTemplatesRequest.builder()
searchFlowTemplatesRequest - A Consumer that will call methods on SearchFlowTemplatesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowTemplatesIterable searchFlowTemplatesPaginator(SearchFlowTemplatesRequest searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about workflows.
This is a variant of
searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client
.searchFlowTemplatesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest)
operation.
searchFlowTemplatesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchFlowTemplatesIterable searchFlowTemplatesPaginator(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about workflows.
This is a variant of
searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client
.searchFlowTemplatesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest)
operation.
This is a convenience which creates an instance of the SearchFlowTemplatesRequest.Builder avoiding the
need to create one manually via SearchFlowTemplatesRequest.builder()
searchFlowTemplatesRequest - A Consumer that will call methods on SearchFlowTemplatesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemInstancesResponse searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for system instances in the user's account.
searchSystemInstancesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemInstancesResponse searchSystemInstances(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for system instances in the user's account.
This is a convenience which creates an instance of the SearchSystemInstancesRequest.Builder avoiding the
need to create one manually via SearchSystemInstancesRequest.builder()
searchSystemInstancesRequest - A Consumer that will call methods on SearchSystemInstancesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemInstancesIterable searchSystemInstancesPaginator(SearchSystemInstancesRequest searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for system instances in the user's account.
This is a variant of
searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client
.searchSystemInstancesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest)
operation.
searchSystemInstancesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemInstancesIterable searchSystemInstancesPaginator(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for system instances in the user's account.
This is a variant of
searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client
.searchSystemInstancesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest)
operation.
This is a convenience which creates an instance of the SearchSystemInstancesRequest.Builder avoiding the
need to create one manually via SearchSystemInstancesRequest.builder()
searchSystemInstancesRequest - A Consumer that will call methods on SearchSystemInstancesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemTemplatesResponse searchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.
searchSystemTemplatesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemTemplatesResponse searchSystemTemplates(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.
This is a convenience which creates an instance of the SearchSystemTemplatesRequest.Builder avoiding the
need to create one manually via SearchSystemTemplatesRequest.builder()
searchSystemTemplatesRequest - A Consumer that will call methods on SearchSystemTemplatesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemTemplatesIterable searchSystemTemplatesPaginator(SearchSystemTemplatesRequest searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.
This is a variant of
searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client
.searchSystemTemplatesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest)
operation.
searchSystemTemplatesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchSystemTemplatesIterable searchSystemTemplatesPaginator(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.
This is a variant of
searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client
.searchSystemTemplatesPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest)
operation.
This is a convenience which creates an instance of the SearchSystemTemplatesRequest.Builder avoiding the
need to create one manually via SearchSystemTemplatesRequest.builder()
searchSystemTemplatesRequest - A Consumer that will call methods on SearchSystemTemplatesRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchThingsResponse searchThings(SearchThingsRequest searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for things associated with the specified entity. You can search by both device and device model.
For example, if two different devices, camera1 and camera2, implement the camera device model, the user can
associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2,
but SearchThings(camera) will return both thing1 and thing2.
This action searches for exact matches and doesn't perform partial text matching.
searchThingsRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchThingsResponse searchThings(Consumer<SearchThingsRequest.Builder> searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for things associated with the specified entity. You can search by both device and device model.
For example, if two different devices, camera1 and camera2, implement the camera device model, the user can
associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2,
but SearchThings(camera) will return both thing1 and thing2.
This action searches for exact matches and doesn't perform partial text matching.
This is a convenience which creates an instance of the SearchThingsRequest.Builder avoiding the need to
create one manually via SearchThingsRequest.builder()
searchThingsRequest - A Consumer that will call methods on SearchThingsRequest.Builder to create a request.InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchThingsIterable searchThingsPaginator(SearchThingsRequest searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for things associated with the specified entity. You can search by both device and device model.
For example, if two different devices, camera1 and camera2, implement the camera device model, the user can
associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2,
but SearchThings(camera) will return both thing1 and thing2.
This action searches for exact matches and doesn't perform partial text matching.
This is a variant of
searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client
.searchThingsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation.
searchThingsRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchThingsIterable searchThingsPaginator(Consumer<SearchThingsRequest.Builder> searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Searches for things associated with the specified entity. You can search by both device and device model.
For example, if two different devices, camera1 and camera2, implement the camera device model, the user can
associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2,
but SearchThings(camera) will return both thing1 and thing2.
This action searches for exact matches and doesn't perform partial text matching.
This is a variant of
searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client
.searchThingsPaginator(request);
for (software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation.
This is a convenience which creates an instance of the SearchThingsRequest.Builder avoiding the need to
create one manually via SearchThingsRequest.builder()
searchThingsRequest - A Consumer that will call methods on SearchThingsRequest.Builder to create a request.InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a tag for the specified resource.
tagResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Creates a tag for the specified resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UndeploySystemInstanceResponse undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Removes a system instance from its target (Cloud or Greengrass).
undeploySystemInstanceRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UndeploySystemInstanceResponse undeploySystemInstance(Consumer<UndeploySystemInstanceRequest.Builder> undeploySystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException
Removes a system instance from its target (Cloud or Greengrass).
This is a convenience which creates an instance of the UndeploySystemInstanceRequest.Builder avoiding the
need to create one manually via UndeploySystemInstanceRequest.builder()
undeploySystemInstanceRequest - A Consumer that will call methods on UndeploySystemInstanceRequest.Builder to create a
request.InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionResourceInUseExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Removes a tag from the specified resource.
untagResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Removes a tag from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFlowTemplateResponse updateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.
updateFlowTemplateRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFlowTemplateResponse updateFlowTemplate(Consumer<UpdateFlowTemplateRequest.Builder> updateFlowTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.
This is a convenience which creates an instance of the UpdateFlowTemplateRequest.Builder avoiding the
need to create one manually via UpdateFlowTemplateRequest.builder()
updateFlowTemplateRequest - A Consumer that will call methods on UpdateFlowTemplateRequest.Builder to create a
request.InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSystemTemplateResponse updateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.
updateSystemTemplateRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSystemTemplateResponse updateSystemTemplate(Consumer<UpdateSystemTemplateRequest.Builder> updateSystemTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException
Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.
This is a convenience which creates an instance of the UpdateSystemTemplateRequest.Builder avoiding the
need to create one manually via UpdateSystemTemplateRequest.builder()
updateSystemTemplateRequest - A Consumer that will call methods on UpdateSystemTemplateRequest.Builder to create a
request.InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadEntityDefinitionsResponse uploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Asynchronously uploads one or more entity definitions to the user's namespace. The document
parameter is required if syncWithPublicNamespace and deleteExistingEntites are false.
If the syncWithPublicNamespace parameter is set to true, the user's namespace will
synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to
true, all entities in the latest version will be deleted before the new DefinitionDocument is
uploaded.
When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The
new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version
increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets
the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to
true.
The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.
Valid entities are Device, DeviceModel, Service, Capability,
State, Action, Event, Property, Mapping,
Enum.
uploadEntityDefinitionsRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadEntityDefinitionsResponse uploadEntityDefinitions(Consumer<UploadEntityDefinitionsRequest.Builder> uploadEntityDefinitionsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException
Asynchronously uploads one or more entity definitions to the user's namespace. The document
parameter is required if syncWithPublicNamespace and deleteExistingEntites are false.
If the syncWithPublicNamespace parameter is set to true, the user's namespace will
synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to
true, all entities in the latest version will be deleted before the new DefinitionDocument is
uploaded.
When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The
new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version
increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets
the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to
true.
The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.
Valid entities are Device, DeviceModel, Service, Capability,
State, Action, Event, Property, Mapping,
Enum.
This is a convenience which creates an instance of the UploadEntityDefinitionsRequest.Builder avoiding
the need to create one manually via UploadEntityDefinitionsRequest.builder()
uploadEntityDefinitionsRequest - A Consumer that will call methods on UploadEntityDefinitionsRequest.Builder to create a
request.InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTThingsGraphException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()