Interface IoTThingsGraphClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,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.
The AWS IoT Things Graph service is discontinued.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateEntityToThingResponseassociateEntityToThing(Consumer<AssociateEntityToThingRequest.Builder> associateEntityToThingRequest) Deprecated.since: 2022-08-30default AssociateEntityToThingResponseassociateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest) Deprecated.since: 2022-08-30static IoTThingsGraphClientBuilderbuilder()Create a builder that can be used to configure and create aIoTThingsGraphClient.static IoTThingsGraphClientcreate()Create aIoTThingsGraphClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateFlowTemplateResponsecreateFlowTemplate(Consumer<CreateFlowTemplateRequest.Builder> createFlowTemplateRequest) Deprecated.since: 2022-08-30default CreateFlowTemplateResponsecreateFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest) Deprecated.since: 2022-08-30default CreateSystemInstanceResponsecreateSystemInstance(Consumer<CreateSystemInstanceRequest.Builder> createSystemInstanceRequest) Deprecated.since: 2022-08-30default CreateSystemInstanceResponsecreateSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest) Deprecated.since: 2022-08-30default CreateSystemTemplateResponsecreateSystemTemplate(Consumer<CreateSystemTemplateRequest.Builder> createSystemTemplateRequest) Deprecated.since: 2022-08-30default CreateSystemTemplateResponsecreateSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest) Deprecated.since: 2022-08-30default DeleteFlowTemplateResponsedeleteFlowTemplate(Consumer<DeleteFlowTemplateRequest.Builder> deleteFlowTemplateRequest) Deprecated.since: 2022-08-30default DeleteFlowTemplateResponsedeleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest) Deprecated.since: 2022-08-30default DeleteNamespaceResponsedeleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) Deprecated.since: 2022-08-30default DeleteNamespaceResponsedeleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) Deprecated.since: 2022-08-30default DeleteSystemInstanceResponsedeleteSystemInstance(Consumer<DeleteSystemInstanceRequest.Builder> deleteSystemInstanceRequest) Deprecated.since: 2022-08-30default DeleteSystemInstanceResponsedeleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest) Deprecated.since: 2022-08-30default DeleteSystemTemplateResponsedeleteSystemTemplate(Consumer<DeleteSystemTemplateRequest.Builder> deleteSystemTemplateRequest) Deprecated.since: 2022-08-30default DeleteSystemTemplateResponsedeleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest) Deprecated.since: 2022-08-30default DeploySystemInstanceResponsedeploySystemInstance(Consumer<DeploySystemInstanceRequest.Builder> deploySystemInstanceRequest) Deprecated.since: 2022-08-30default DeploySystemInstanceResponsedeploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest) Deprecated.since: 2022-08-30default DeprecateFlowTemplateResponsedeprecateFlowTemplate(Consumer<DeprecateFlowTemplateRequest.Builder> deprecateFlowTemplateRequest) Deprecated.since: 2022-08-30default DeprecateFlowTemplateResponsedeprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest) Deprecated.since: 2022-08-30default DeprecateSystemTemplateResponsedeprecateSystemTemplate(Consumer<DeprecateSystemTemplateRequest.Builder> deprecateSystemTemplateRequest) Deprecated.since: 2022-08-30default DeprecateSystemTemplateResponsedeprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest) Deprecated.since: 2022-08-30default DescribeNamespaceResponsedescribeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) Deprecated.since: 2022-08-30default DescribeNamespaceResponsedescribeNamespace(DescribeNamespaceRequest describeNamespaceRequest) Deprecated.since: 2022-08-30dissociateEntityFromThing(Consumer<DissociateEntityFromThingRequest.Builder> dissociateEntityFromThingRequest) Deprecated.since: 2022-08-30dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest) Deprecated.since: 2022-08-30default GetEntitiesResponsegetEntities(Consumer<GetEntitiesRequest.Builder> getEntitiesRequest) Deprecated.since: 2022-08-30default GetEntitiesResponsegetEntities(GetEntitiesRequest getEntitiesRequest) Deprecated.since: 2022-08-30default GetFlowTemplateResponsegetFlowTemplate(Consumer<GetFlowTemplateRequest.Builder> getFlowTemplateRequest) Deprecated.since: 2022-08-30default GetFlowTemplateResponsegetFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest) Deprecated.since: 2022-08-30default GetFlowTemplateRevisionsResponsegetFlowTemplateRevisions(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) Deprecated.since: 2022-08-30default GetFlowTemplateRevisionsResponsegetFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) Deprecated.since: 2022-08-30default GetFlowTemplateRevisionsIterablegetFlowTemplateRevisionsPaginator(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) Deprecated.since: 2022-08-30default GetFlowTemplateRevisionsIterablegetFlowTemplateRevisionsPaginator(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) Deprecated.since: 2022-08-30getNamespaceDeletionStatus(Consumer<GetNamespaceDeletionStatusRequest.Builder> getNamespaceDeletionStatusRequest) Deprecated.since: 2022-08-30getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest) Deprecated.since: 2022-08-30default GetSystemInstanceResponsegetSystemInstance(Consumer<GetSystemInstanceRequest.Builder> getSystemInstanceRequest) Deprecated.since: 2022-08-30default GetSystemInstanceResponsegetSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest) Deprecated.since: 2022-08-30default GetSystemTemplateResponsegetSystemTemplate(Consumer<GetSystemTemplateRequest.Builder> getSystemTemplateRequest) Deprecated.since: 2022-08-30default GetSystemTemplateResponsegetSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest) Deprecated.since: 2022-08-30getSystemTemplateRevisions(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) Deprecated.since: 2022-08-30getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) Deprecated.since: 2022-08-30getSystemTemplateRevisionsPaginator(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) Deprecated.since: 2022-08-30getSystemTemplateRevisionsPaginator(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) Deprecated.since: 2022-08-30default GetUploadStatusResponsegetUploadStatus(Consumer<GetUploadStatusRequest.Builder> getUploadStatusRequest) Deprecated.since: 2022-08-30default GetUploadStatusResponsegetUploadStatus(GetUploadStatusRequest getUploadStatusRequest) Deprecated.since: 2022-08-30listFlowExecutionMessages(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) Deprecated.since: 2022-08-30listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) Deprecated.since: 2022-08-30listFlowExecutionMessagesPaginator(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) Deprecated.since: 2022-08-30listFlowExecutionMessagesPaginator(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) Deprecated.since: 2022-08-30default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Deprecated.since: 2022-08-30default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Deprecated.since: 2022-08-30default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Deprecated.since: 2022-08-30default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) Deprecated.since: 2022-08-30default SearchEntitiesResponsesearchEntities(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) Deprecated.since: 2022-08-30default SearchEntitiesResponsesearchEntities(SearchEntitiesRequest searchEntitiesRequest) Deprecated.since: 2022-08-30default SearchEntitiesIterablesearchEntitiesPaginator(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) Deprecated.since: 2022-08-30default SearchEntitiesIterablesearchEntitiesPaginator(SearchEntitiesRequest searchEntitiesRequest) Deprecated.since: 2022-08-30default SearchFlowExecutionsResponsesearchFlowExecutions(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) Deprecated.since: 2022-08-30default SearchFlowExecutionsResponsesearchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest) Deprecated.since: 2022-08-30default SearchFlowExecutionsIterablesearchFlowExecutionsPaginator(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) Deprecated.since: 2022-08-30default SearchFlowExecutionsIterablesearchFlowExecutionsPaginator(SearchFlowExecutionsRequest searchFlowExecutionsRequest) Deprecated.since: 2022-08-30default SearchFlowTemplatesResponsesearchFlowTemplates(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) Deprecated.since: 2022-08-30default SearchFlowTemplatesResponsesearchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest) Deprecated.since: 2022-08-30default SearchFlowTemplatesIterablesearchFlowTemplatesPaginator(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) Deprecated.since: 2022-08-30default SearchFlowTemplatesIterablesearchFlowTemplatesPaginator(SearchFlowTemplatesRequest searchFlowTemplatesRequest) Deprecated.since: 2022-08-30default SearchSystemInstancesResponsesearchSystemInstances(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) Deprecated.since: 2022-08-30default SearchSystemInstancesResponsesearchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest) Deprecated.since: 2022-08-30default SearchSystemInstancesIterablesearchSystemInstancesPaginator(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) Deprecated.since: 2022-08-30default SearchSystemInstancesIterablesearchSystemInstancesPaginator(SearchSystemInstancesRequest searchSystemInstancesRequest) Deprecated.since: 2022-08-30default SearchSystemTemplatesResponsesearchSystemTemplates(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) Deprecated.since: 2022-08-30default SearchSystemTemplatesResponsesearchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest) Deprecated.since: 2022-08-30default SearchSystemTemplatesIterablesearchSystemTemplatesPaginator(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) Deprecated.since: 2022-08-30default SearchSystemTemplatesIterablesearchSystemTemplatesPaginator(SearchSystemTemplatesRequest searchSystemTemplatesRequest) Deprecated.since: 2022-08-30default SearchThingsResponsesearchThings(Consumer<SearchThingsRequest.Builder> searchThingsRequest) Deprecated.since: 2022-08-30default SearchThingsResponsesearchThings(SearchThingsRequest searchThingsRequest) Deprecated.since: 2022-08-30default SearchThingsIterablesearchThingsPaginator(Consumer<SearchThingsRequest.Builder> searchThingsRequest) Deprecated.since: 2022-08-30default SearchThingsIterablesearchThingsPaginator(SearchThingsRequest searchThingsRequest) Deprecated.since: 2022-08-30The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Deprecated.since: 2022-08-30default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Deprecated.since: 2022-08-30default UndeploySystemInstanceResponseundeploySystemInstance(Consumer<UndeploySystemInstanceRequest.Builder> undeploySystemInstanceRequest) Deprecated.since: 2022-08-30default UndeploySystemInstanceResponseundeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest) Deprecated.since: 2022-08-30default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deprecated.since: 2022-08-30default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Deprecated.since: 2022-08-30default UpdateFlowTemplateResponseupdateFlowTemplate(Consumer<UpdateFlowTemplateRequest.Builder> updateFlowTemplateRequest) Deprecated.since: 2022-08-30default UpdateFlowTemplateResponseupdateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest) Deprecated.since: 2022-08-30default UpdateSystemTemplateResponseupdateSystemTemplate(Consumer<UpdateSystemTemplateRequest.Builder> updateSystemTemplateRequest) Deprecated.since: 2022-08-30default UpdateSystemTemplateResponseupdateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest) Deprecated.since: 2022-08-30default UploadEntityDefinitionsResponseuploadEntityDefinitions(Consumer<UploadEntityDefinitionsRequest.Builder> uploadEntityDefinitionsRequest) Deprecated.since: 2022-08-30default UploadEntityDefinitionsResponseuploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest) Deprecated.since: 2022-08-30Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
associateEntityToThing
@Deprecated default AssociateEntityToThingResponse associateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Associates 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.
- Parameters:
associateEntityToThingRequest-- Returns:
- Result of the AssociateEntityToThing operation returned by the service.
- See Also:
-
associateEntityToThing
@Deprecated default AssociateEntityToThingResponse associateEntityToThing(Consumer<AssociateEntityToThingRequest.Builder> associateEntityToThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Associates 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.Builderavoiding the need to create one manually viaAssociateEntityToThingRequest.builder()- Parameters:
associateEntityToThingRequest- AConsumerthat will call methods onAssociateEntityToThingRequest.Builderto create a request.- Returns:
- Result of the AssociateEntityToThing operation returned by the service.
- See Also:
-
createFlowTemplate
@Deprecated default CreateFlowTemplateResponse createFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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.
- Parameters:
createFlowTemplateRequest-- Returns:
- Result of the CreateFlowTemplate operation returned by the service.
- See Also:
-
createFlowTemplate
@Deprecated default CreateFlowTemplateResponse createFlowTemplate(Consumer<CreateFlowTemplateRequest.Builder> createFlowTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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.Builderavoiding the need to create one manually viaCreateFlowTemplateRequest.builder()- Parameters:
createFlowTemplateRequest- AConsumerthat will call methods onCreateFlowTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateFlowTemplate operation returned by the service.
- See Also:
-
createSystemInstance
@Deprecated default CreateSystemInstanceResponse createSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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
greengrassGroupNameparameter. It also adds a file to the S3 bucket specified by thes3BucketNameparameter. You need to callDeploySystemInstanceafter 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
flowActionsRoleArnvalue. 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.
- Parameters:
createSystemInstanceRequest-- Returns:
- Result of the CreateSystemInstance operation returned by the service.
- See Also:
-
createSystemInstance
@Deprecated default CreateSystemInstanceResponse createSystemInstance(Consumer<CreateSystemInstanceRequest.Builder> createSystemInstanceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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
greengrassGroupNameparameter. It also adds a file to the S3 bucket specified by thes3BucketNameparameter. You need to callDeploySystemInstanceafter 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
flowActionsRoleArnvalue. 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.Builderavoiding the need to create one manually viaCreateSystemInstanceRequest.builder()- Parameters:
createSystemInstanceRequest- AConsumerthat will call methods onCreateSystemInstanceRequest.Builderto create a request.- Returns:
- Result of the CreateSystemInstance operation returned by the service.
- See Also:
-
createSystemTemplate
@Deprecated default CreateSystemTemplateResponse createSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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.
- Parameters:
createSystemTemplateRequest-- Returns:
- Result of the CreateSystemTemplate operation returned by the service.
- See Also:
-
createSystemTemplate
@Deprecated default CreateSystemTemplateResponse createSystemTemplate(Consumer<CreateSystemTemplateRequest.Builder> createSystemTemplateRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates 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.Builderavoiding the need to create one manually viaCreateSystemTemplateRequest.builder()- Parameters:
createSystemTemplateRequest- AConsumerthat will call methods onCreateSystemTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateSystemTemplate operation returned by the service.
- See Also:
-
deleteFlowTemplate
@Deprecated default DeleteFlowTemplateResponse deleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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).
- Parameters:
deleteFlowTemplateRequest-- Returns:
- Result of the DeleteFlowTemplate operation returned by the service.
- See Also:
-
deleteFlowTemplate
@Deprecated default DeleteFlowTemplateResponse deleteFlowTemplate(Consumer<DeleteFlowTemplateRequest.Builder> deleteFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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.Builderavoiding the need to create one manually viaDeleteFlowTemplateRequest.builder()- Parameters:
deleteFlowTemplateRequest- AConsumerthat will call methods onDeleteFlowTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteFlowTemplate operation returned by the service.
- See Also:
-
deleteNamespace
@Deprecated default DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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 action takes no request parameters.
- Parameters:
deleteNamespaceRequest-- Returns:
- Result of the DeleteNamespace operation returned by the service.
- See Also:
-
deleteNamespace
@Deprecated default DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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 action takes no request parameters.
This is a convenience which creates an instance of the
DeleteNamespaceRequest.Builderavoiding the need to create one manually viaDeleteNamespaceRequest.builder()- Parameters:
deleteNamespaceRequest- AConsumerthat will call methods onDeleteNamespaceRequest.Builderto create a request.- Returns:
- Result of the DeleteNamespace operation returned by the service.
- See Also:
-
deleteSystemInstance
@Deprecated default DeleteSystemInstanceResponse deleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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.
- Parameters:
deleteSystemInstanceRequest-- Returns:
- Result of the DeleteSystemInstance operation returned by the service.
- See Also:
-
deleteSystemInstance
@Deprecated default DeleteSystemInstanceResponse deleteSystemInstance(Consumer<DeleteSystemInstanceRequest.Builder> deleteSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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.Builderavoiding the need to create one manually viaDeleteSystemInstanceRequest.builder()- Parameters:
deleteSystemInstanceRequest- AConsumerthat will call methods onDeleteSystemInstanceRequest.Builderto create a request.- Returns:
- Result of the DeleteSystemInstance operation returned by the service.
- See Also:
-
deleteSystemTemplate
@Deprecated default DeleteSystemTemplateResponse deleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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.
- Parameters:
deleteSystemTemplateRequest-- Returns:
- Result of the DeleteSystemTemplate operation returned by the service.
- See Also:
-
deleteSystemTemplate
@Deprecated default DeleteSystemTemplateResponse deleteSystemTemplate(Consumer<DeleteSystemTemplateRequest.Builder> deleteSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deletes 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.Builderavoiding the need to create one manually viaDeleteSystemTemplateRequest.builder()- Parameters:
deleteSystemTemplateRequest- AConsumerthat will call methods onDeleteSystemTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteSystemTemplate operation returned by the service.
- See Also:
-
deploySystemInstance
@Deprecated default DeploySystemInstanceResponse deploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Greengrass 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.
- Parameters:
deploySystemInstanceRequest-- Returns:
- Result of the DeploySystemInstance operation returned by the service.
- See Also:
-
deploySystemInstance
@Deprecated default DeploySystemInstanceResponse deploySystemInstance(Consumer<DeploySystemInstanceRequest.Builder> deploySystemInstanceRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Greengrass 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.Builderavoiding the need to create one manually viaDeploySystemInstanceRequest.builder()- Parameters:
deploySystemInstanceRequest- AConsumerthat will call methods onDeploySystemInstanceRequest.Builderto create a request.- Returns:
- Result of the DeploySystemInstance operation returned by the service.
- See Also:
-
deprecateFlowTemplate
@Deprecated default DeprecateFlowTemplateResponse deprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
- Parameters:
deprecateFlowTemplateRequest-- Returns:
- Result of the DeprecateFlowTemplate operation returned by the service.
- See Also:
-
deprecateFlowTemplate
@Deprecated default DeprecateFlowTemplateResponse deprecateFlowTemplate(Consumer<DeprecateFlowTemplateRequest.Builder> deprecateFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deprecates 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.Builderavoiding the need to create one manually viaDeprecateFlowTemplateRequest.builder()- Parameters:
deprecateFlowTemplateRequest- AConsumerthat will call methods onDeprecateFlowTemplateRequest.Builderto create a request.- Returns:
- Result of the DeprecateFlowTemplate operation returned by the service.
- See Also:
-
deprecateSystemTemplate
@Deprecated default DeprecateSystemTemplateResponse deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deprecates the specified system.
- Parameters:
deprecateSystemTemplateRequest-- Returns:
- Result of the DeprecateSystemTemplate operation returned by the service.
- See Also:
-
deprecateSystemTemplate
@Deprecated default DeprecateSystemTemplateResponse deprecateSystemTemplate(Consumer<DeprecateSystemTemplateRequest.Builder> deprecateSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Deprecates the specified system.
This is a convenience which creates an instance of the
DeprecateSystemTemplateRequest.Builderavoiding the need to create one manually viaDeprecateSystemTemplateRequest.builder()- Parameters:
deprecateSystemTemplateRequest- AConsumerthat will call methods onDeprecateSystemTemplateRequest.Builderto create a request.- Returns:
- Result of the DeprecateSystemTemplate operation returned by the service.
- See Also:
-
describeNamespace
@Deprecated default DescribeNamespaceResponse describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the latest version of the user's namespace and the public version that it is tracking.
- Parameters:
describeNamespaceRequest-- Returns:
- Result of the DescribeNamespace operation returned by the service.
- See Also:
-
describeNamespace
@Deprecated default DescribeNamespaceResponse describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.Builderavoiding the need to create one manually viaDescribeNamespaceRequest.builder()- Parameters:
describeNamespaceRequest- AConsumerthat will call methods onDescribeNamespaceRequest.Builderto create a request.- Returns:
- Result of the DescribeNamespace operation returned by the service.
- See Also:
-
dissociateEntityFromThing
@Deprecated default DissociateEntityFromThingResponse dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Dissociates 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.
- Parameters:
dissociateEntityFromThingRequest-- Returns:
- Result of the DissociateEntityFromThing operation returned by the service.
- See Also:
-
dissociateEntityFromThing
@Deprecated default DissociateEntityFromThingResponse dissociateEntityFromThing(Consumer<DissociateEntityFromThingRequest.Builder> dissociateEntityFromThingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Dissociates 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.Builderavoiding the need to create one manually viaDissociateEntityFromThingRequest.builder()- Parameters:
dissociateEntityFromThingRequest- AConsumerthat will call methods onDissociateEntityFromThingRequest.Builderto create a request.- Returns:
- Result of the DissociateEntityFromThing operation returned by the service.
- See Also:
-
getEntities
@Deprecated default GetEntitiesResponse getEntities(GetEntitiesRequest getEntitiesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.
- Parameters:
getEntitiesRequest-- Returns:
- Result of the GetEntities operation returned by the service.
- See Also:
-
-
getEntities
@Deprecated default GetEntitiesResponse getEntities(Consumer<GetEntitiesRequest.Builder> getEntitiesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.Builderavoiding the need to create one manually viaGetEntitiesRequest.builder()- Parameters:
getEntitiesRequest- AConsumerthat will call methods onGetEntitiesRequest.Builderto create a request.- Returns:
- Result of the GetEntities operation returned by the service.
- See Also:
-
-
getFlowTemplate
@Deprecated default GetFlowTemplateResponse getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the latest version of the
DefinitionDocumentandFlowTemplateSummaryfor the specified workflow.- Parameters:
getFlowTemplateRequest-- Returns:
- Result of the GetFlowTemplate operation returned by the service.
- See Also:
-
getFlowTemplate
@Deprecated default GetFlowTemplateResponse getFlowTemplate(Consumer<GetFlowTemplateRequest.Builder> getFlowTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the latest version of the
DefinitionDocumentandFlowTemplateSummaryfor the specified workflow.
This is a convenience which creates an instance of the
GetFlowTemplateRequest.Builderavoiding the need to create one manually viaGetFlowTemplateRequest.builder()- Parameters:
getFlowTemplateRequest- AConsumerthat will call methods onGetFlowTemplateRequest.Builderto create a request.- Returns:
- Result of the GetFlowTemplate operation returned by the service.
- See Also:
-
getFlowTemplateRevisions
@Deprecated default GetFlowTemplateRevisionsResponse getFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.
- Parameters:
getFlowTemplateRevisionsRequest-- Returns:
- Result of the GetFlowTemplateRevisions operation returned by the service.
- See Also:
-
getFlowTemplateRevisions
@Deprecated default GetFlowTemplateRevisionsResponse getFlowTemplateRevisions(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.Builderavoiding the need to create one manually viaGetFlowTemplateRevisionsRequest.builder()- Parameters:
getFlowTemplateRevisionsRequest- AConsumerthat will call methods onGetFlowTemplateRevisionsRequest.Builderto create a request.- Returns:
- Result of the GetFlowTemplateRevisions operation returned by the service.
- See Also:
-
getFlowTemplateRevisionsPaginator
@Deprecated default GetFlowTemplateRevisionsIterable getFlowTemplateRevisionsPaginator(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
getFlowTemplateRevisionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getFlowTemplateRevisionsPaginator
@Deprecated default GetFlowTemplateRevisionsIterable getFlowTemplateRevisionsPaginator(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsIterable responses = client.getFlowTemplateRevisionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetFlowTemplateRevisionsRequest.builder()- Parameters:
getFlowTemplateRevisionsRequest- AConsumerthat will call methods onGetFlowTemplateRevisionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getNamespaceDeletionStatus
@Deprecated default GetNamespaceDeletionStatusResponse getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the status of a namespace deletion task.
- Parameters:
getNamespaceDeletionStatusRequest-- Returns:
- Result of the GetNamespaceDeletionStatus operation returned by the service.
- See Also:
-
getNamespaceDeletionStatus
@Deprecated default GetNamespaceDeletionStatusResponse getNamespaceDeletionStatus(Consumer<GetNamespaceDeletionStatusRequest.Builder> getNamespaceDeletionStatusRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the status of a namespace deletion task.
This is a convenience which creates an instance of the
GetNamespaceDeletionStatusRequest.Builderavoiding the need to create one manually viaGetNamespaceDeletionStatusRequest.builder()- Parameters:
getNamespaceDeletionStatusRequest- AConsumerthat will call methods onGetNamespaceDeletionStatusRequest.Builderto create a request.- Returns:
- Result of the GetNamespaceDeletionStatus operation returned by the service.
- See Also:
-
getSystemInstance
@Deprecated default GetSystemInstanceResponse getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets a system instance.
- Parameters:
getSystemInstanceRequest-- Returns:
- Result of the GetSystemInstance operation returned by the service.
- See Also:
-
getSystemInstance
@Deprecated default GetSystemInstanceResponse getSystemInstance(Consumer<GetSystemInstanceRequest.Builder> getSystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets a system instance.
This is a convenience which creates an instance of the
GetSystemInstanceRequest.Builderavoiding the need to create one manually viaGetSystemInstanceRequest.builder()- Parameters:
getSystemInstanceRequest- AConsumerthat will call methods onGetSystemInstanceRequest.Builderto create a request.- Returns:
- Result of the GetSystemInstance operation returned by the service.
- See Also:
-
getSystemTemplate
@Deprecated default GetSystemTemplateResponse getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets a system.
- Parameters:
getSystemTemplateRequest-- Returns:
- Result of the GetSystemTemplate operation returned by the service.
- See Also:
-
getSystemTemplate
@Deprecated default GetSystemTemplateResponse getSystemTemplate(Consumer<GetSystemTemplateRequest.Builder> getSystemTemplateRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets a system.
This is a convenience which creates an instance of the
GetSystemTemplateRequest.Builderavoiding the need to create one manually viaGetSystemTemplateRequest.builder()- Parameters:
getSystemTemplateRequest- AConsumerthat will call methods onGetSystemTemplateRequest.Builderto create a request.- Returns:
- Result of the GetSystemTemplate operation returned by the service.
- See Also:
-
getSystemTemplateRevisions
@Deprecated default GetSystemTemplateRevisionsResponse getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.
- Parameters:
getSystemTemplateRevisionsRequest-- Returns:
- Result of the GetSystemTemplateRevisions operation returned by the service.
- See Also:
-
getSystemTemplateRevisions
@Deprecated default GetSystemTemplateRevisionsResponse getSystemTemplateRevisions(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets 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.Builderavoiding the need to create one manually viaGetSystemTemplateRevisionsRequest.builder()- Parameters:
getSystemTemplateRevisionsRequest- AConsumerthat will call methods onGetSystemTemplateRevisionsRequest.Builderto create a request.- Returns:
- Result of the GetSystemTemplateRevisions operation returned by the service.
- See Also:
-
getSystemTemplateRevisionsPaginator
@Deprecated default GetSystemTemplateRevisionsIterable getSystemTemplateRevisionsPaginator(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
getSystemTemplateRevisionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSystemTemplateRevisionsPaginator
@Deprecated default GetSystemTemplateRevisionsIterable getSystemTemplateRevisionsPaginator(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsIterable responses = client.getSystemTemplateRevisionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetSystemTemplateRevisionsRequest.builder()- Parameters:
getSystemTemplateRevisionsRequest- AConsumerthat will call methods onGetSystemTemplateRevisionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getUploadStatus
@Deprecated default GetUploadStatusResponse getUploadStatus(GetUploadStatusRequest getUploadStatusRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the status of the specified upload.
- Parameters:
getUploadStatusRequest-- Returns:
- Result of the GetUploadStatus operation returned by the service.
- See Also:
-
getUploadStatus
@Deprecated default GetUploadStatusResponse getUploadStatus(Consumer<GetUploadStatusRequest.Builder> getUploadStatusRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Gets the status of the specified upload.
This is a convenience which creates an instance of the
GetUploadStatusRequest.Builderavoiding the need to create one manually viaGetUploadStatusRequest.builder()- Parameters:
getUploadStatusRequest- AConsumerthat will call methods onGetUploadStatusRequest.Builderto create a request.- Returns:
- Result of the GetUploadStatus operation returned by the service.
- See Also:
-
listFlowExecutionMessages
@Deprecated default ListFlowExecutionMessagesResponse listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Returns a list of objects that contain information about events in a flow execution.
- Parameters:
listFlowExecutionMessagesRequest-- Returns:
- Result of the ListFlowExecutionMessages operation returned by the service.
- See Also:
-
listFlowExecutionMessages
@Deprecated default ListFlowExecutionMessagesResponse listFlowExecutionMessages(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Returns a list of objects that contain information about events in a flow execution.
This is a convenience which creates an instance of the
ListFlowExecutionMessagesRequest.Builderavoiding the need to create one manually viaListFlowExecutionMessagesRequest.builder()- Parameters:
listFlowExecutionMessagesRequest- AConsumerthat will call methods onListFlowExecutionMessagesRequest.Builderto create a request.- Returns:
- Result of the ListFlowExecutionMessages operation returned by the service.
- See Also:
-
listFlowExecutionMessagesPaginator
@Deprecated default ListFlowExecutionMessagesIterable listFlowExecutionMessagesPaginator(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listFlowExecutionMessagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlowExecutionMessagesPaginator
@Deprecated default ListFlowExecutionMessagesIterable listFlowExecutionMessagesPaginator(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesIterable responses = client.listFlowExecutionMessagesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListFlowExecutionMessagesRequest.builder()- Parameters:
listFlowExecutionMessagesRequest- AConsumerthat will call methods onListFlowExecutionMessagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
@Deprecated default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Lists all tags on an AWS IoT Things Graph resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
@Deprecated default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Lists all tags on an AWS IoT Things Graph resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
@Deprecated default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listTagsForResourceRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
@Deprecated default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchEntities
@Deprecated default SearchEntitiesResponse searchEntities(SearchEntitiesRequest searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
- Parameters:
searchEntitiesRequest-- Returns:
- Result of the SearchEntities operation returned by the service.
- See Also:
-
searchEntities
@Deprecated default SearchEntitiesResponse searchEntities(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches 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.Builderavoiding the need to create one manually viaSearchEntitiesRequest.builder()- Parameters:
searchEntitiesRequest- AConsumerthat will call methods onSearchEntitiesRequest.Builderto create a request.- Returns:
- Result of the SearchEntities operation returned by the service.
- See Also:
-
searchEntitiesPaginator
@Deprecated default SearchEntitiesIterable searchEntitiesPaginator(SearchEntitiesRequest searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchEntitiesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchEntitiesPaginator
@Deprecated default SearchEntitiesIterable searchEntitiesPaginator(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesIterable responses = client.searchEntitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchEntitiesRequest.builder()- Parameters:
searchEntitiesRequest- AConsumerthat will call methods onSearchEntitiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFlowExecutions
@Deprecated default SearchFlowExecutionsResponse searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for AWS IoT Things Graph workflow execution instances.
- Parameters:
searchFlowExecutionsRequest-- Returns:
- Result of the SearchFlowExecutions operation returned by the service.
- See Also:
-
searchFlowExecutions
@Deprecated default SearchFlowExecutionsResponse searchFlowExecutions(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for AWS IoT Things Graph workflow execution instances.
This is a convenience which creates an instance of the
SearchFlowExecutionsRequest.Builderavoiding the need to create one manually viaSearchFlowExecutionsRequest.builder()- Parameters:
searchFlowExecutionsRequest- AConsumerthat will call methods onSearchFlowExecutionsRequest.Builderto create a request.- Returns:
- Result of the SearchFlowExecutions operation returned by the service.
- See Also:
-
searchFlowExecutionsPaginator
@Deprecated default SearchFlowExecutionsIterable searchFlowExecutionsPaginator(SearchFlowExecutionsRequest searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchFlowExecutionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFlowExecutionsPaginator
@Deprecated default SearchFlowExecutionsIterable searchFlowExecutionsPaginator(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsIterable responses = client.searchFlowExecutionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchFlowExecutionsRequest.builder()- Parameters:
searchFlowExecutionsRequest- AConsumerthat will call methods onSearchFlowExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFlowTemplates
@Deprecated default SearchFlowTemplatesResponse searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for summary information about workflows.
- Parameters:
searchFlowTemplatesRequest-- Returns:
- Result of the SearchFlowTemplates operation returned by the service.
- See Also:
-
searchFlowTemplates
@Deprecated default SearchFlowTemplatesResponse searchFlowTemplates(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for summary information about workflows.
This is a convenience which creates an instance of the
SearchFlowTemplatesRequest.Builderavoiding the need to create one manually viaSearchFlowTemplatesRequest.builder()- Parameters:
searchFlowTemplatesRequest- AConsumerthat will call methods onSearchFlowTemplatesRequest.Builderto create a request.- Returns:
- Result of the SearchFlowTemplates operation returned by the service.
- See Also:
-
searchFlowTemplatesPaginator
@Deprecated default SearchFlowTemplatesIterable searchFlowTemplatesPaginator(SearchFlowTemplatesRequest searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchFlowTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFlowTemplatesPaginator
@Deprecated default SearchFlowTemplatesIterable searchFlowTemplatesPaginator(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesIterable responses = client.searchFlowTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchFlowTemplatesRequest.builder()- Parameters:
searchFlowTemplatesRequest- AConsumerthat will call methods onSearchFlowTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSystemInstances
@Deprecated default SearchSystemInstancesResponse searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for system instances in the user's account.
- Parameters:
searchSystemInstancesRequest-- Returns:
- Result of the SearchSystemInstances operation returned by the service.
- See Also:
-
searchSystemInstances
@Deprecated default SearchSystemInstancesResponse searchSystemInstances(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches for system instances in the user's account.
This is a convenience which creates an instance of the
SearchSystemInstancesRequest.Builderavoiding the need to create one manually viaSearchSystemInstancesRequest.builder()- Parameters:
searchSystemInstancesRequest- AConsumerthat will call methods onSearchSystemInstancesRequest.Builderto create a request.- Returns:
- Result of the SearchSystemInstances operation returned by the service.
- See Also:
-
searchSystemInstancesPaginator
@Deprecated default SearchSystemInstancesIterable searchSystemInstancesPaginator(SearchSystemInstancesRequest searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchSystemInstancesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSystemInstancesPaginator
@Deprecated default SearchSystemInstancesIterable searchSystemInstancesPaginator(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesIterable responses = client.searchSystemInstancesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchSystemInstancesRequest.builder()- Parameters:
searchSystemInstancesRequest- AConsumerthat will call methods onSearchSystemInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSystemTemplates
@Deprecated default SearchSystemTemplatesResponse searchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches 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.
- Parameters:
searchSystemTemplatesRequest-- Returns:
- Result of the SearchSystemTemplates operation returned by the service.
- See Also:
-
searchSystemTemplates
@Deprecated default SearchSystemTemplatesResponse searchSystemTemplates(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches 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.Builderavoiding the need to create one manually viaSearchSystemTemplatesRequest.builder()- Parameters:
searchSystemTemplatesRequest- AConsumerthat will call methods onSearchSystemTemplatesRequest.Builderto create a request.- Returns:
- Result of the SearchSystemTemplates operation returned by the service.
- See Also:
-
searchSystemTemplatesPaginator
@Deprecated default SearchSystemTemplatesIterable searchSystemTemplatesPaginator(SearchSystemTemplatesRequest searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchSystemTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSystemTemplatesPaginator
@Deprecated default SearchSystemTemplatesIterable searchSystemTemplatesPaginator(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesIterable responses = client.searchSystemTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchSystemTemplatesRequest.builder()- Parameters:
searchSystemTemplatesRequest- AConsumerthat will call methods onSearchSystemTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchThings
@Deprecated default SearchThingsResponse searchThings(SearchThingsRequest searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches 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, butSearchThings(camera)will return both thing1 and thing2.This action searches for exact matches and doesn't perform partial text matching.
- Parameters:
searchThingsRequest-- Returns:
- Result of the SearchThings operation returned by the service.
- See Also:
-
searchThings
@Deprecated default SearchThingsResponse searchThings(Consumer<SearchThingsRequest.Builder> searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Searches 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, butSearchThings(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.Builderavoiding the need to create one manually viaSearchThingsRequest.builder()- Parameters:
searchThingsRequest- AConsumerthat will call methods onSearchThingsRequest.Builderto create a request.- Returns:
- Result of the SearchThings operation returned by the service.
- See Also:
-
searchThingsPaginator
@Deprecated default SearchThingsIterable searchThingsPaginator(SearchThingsRequest searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchThingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchThingsPaginator
@Deprecated default SearchThingsIterable searchThingsPaginator(Consumer<SearchThingsRequest.Builder> searchThingsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30This 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
2) Using For loopsoftware.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsIterable responses = client.searchThingsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchThingsRequest.builder()- Parameters:
searchThingsRequest- AConsumerthat will call methods onSearchThingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
tagResource
@Deprecated default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates a tag for the specified resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
@Deprecated default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Creates a tag for the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
undeploySystemInstance
@Deprecated default UndeploySystemInstanceResponse undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Removes a system instance from its target (Cloud or Greengrass).
- Parameters:
undeploySystemInstanceRequest-- Returns:
- Result of the UndeploySystemInstance operation returned by the service.
- See Also:
-
undeploySystemInstance
@Deprecated default UndeploySystemInstanceResponse undeploySystemInstance(Consumer<UndeploySystemInstanceRequest.Builder> undeploySystemInstanceRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Removes a system instance from its target (Cloud or Greengrass).
This is a convenience which creates an instance of the
UndeploySystemInstanceRequest.Builderavoiding the need to create one manually viaUndeploySystemInstanceRequest.builder()- Parameters:
undeploySystemInstanceRequest- AConsumerthat will call methods onUndeploySystemInstanceRequest.Builderto create a request.- Returns:
- Result of the UndeploySystemInstance operation returned by the service.
- See Also:
-
untagResource
@Deprecated default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Removes a tag from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
@Deprecated default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Removes a tag from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateFlowTemplate
@Deprecated default UpdateFlowTemplateResponse updateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Updates 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.
- Parameters:
updateFlowTemplateRequest-- Returns:
- Result of the UpdateFlowTemplate operation returned by the service.
- See Also:
-
updateFlowTemplate
@Deprecated default UpdateFlowTemplateResponse updateFlowTemplate(Consumer<UpdateFlowTemplateRequest.Builder> updateFlowTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Updates 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.Builderavoiding the need to create one manually viaUpdateFlowTemplateRequest.builder()- Parameters:
updateFlowTemplateRequest- AConsumerthat will call methods onUpdateFlowTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateFlowTemplate operation returned by the service.
- See Also:
-
updateSystemTemplate
@Deprecated default UpdateSystemTemplateResponse updateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Updates 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.
- Parameters:
updateSystemTemplateRequest-- Returns:
- Result of the UpdateSystemTemplate operation returned by the service.
- See Also:
-
updateSystemTemplate
@Deprecated default UpdateSystemTemplateResponse updateSystemTemplate(Consumer<UpdateSystemTemplateRequest.Builder> updateSystemTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Updates 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.Builderavoiding the need to create one manually viaUpdateSystemTemplateRequest.builder()- Parameters:
updateSystemTemplateRequest- AConsumerthat will call methods onUpdateSystemTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateSystemTemplate operation returned by the service.
- See Also:
-
uploadEntityDefinitions
@Deprecated default UploadEntityDefinitionsResponse uploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Asynchronously uploads one or more entity definitions to the user's namespace. The
documentparameter is required ifsyncWithPublicNamespaceanddeleteExistingEntitesare false. If thesyncWithPublicNamespaceparameter is set totrue, the user's namespace will synchronize with the latest version of the public namespace. IfdeprecateExistingEntitiesis set to true, all entities in the latest version will be deleted before the newDefinitionDocumentis 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
syncWithPublicNamespaceparameter or thedeprecateExistingEntitiesparameter totrue.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.- Parameters:
uploadEntityDefinitionsRequest-- Returns:
- Result of the UploadEntityDefinitions operation returned by the service.
- See Also:
-
uploadEntityDefinitions
@Deprecated default UploadEntityDefinitionsResponse uploadEntityDefinitions(Consumer<UploadEntityDefinitionsRequest.Builder> uploadEntityDefinitionsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTThingsGraphException Deprecated.since: 2022-08-30Asynchronously uploads one or more entity definitions to the user's namespace. The
documentparameter is required ifsyncWithPublicNamespaceanddeleteExistingEntitesare false. If thesyncWithPublicNamespaceparameter is set totrue, the user's namespace will synchronize with the latest version of the public namespace. IfdeprecateExistingEntitiesis set to true, all entities in the latest version will be deleted before the newDefinitionDocumentis 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
syncWithPublicNamespaceparameter or thedeprecateExistingEntitiesparameter totrue.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.Builderavoiding the need to create one manually viaUploadEntityDefinitionsRequest.builder()- Parameters:
uploadEntityDefinitionsRequest- AConsumerthat will call methods onUploadEntityDefinitionsRequest.Builderto create a request.- Returns:
- Result of the UploadEntityDefinitions operation returned by the service.
- See Also:
-
create
Create aIoTThingsGraphClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aIoTThingsGraphClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-