Interface GreengrassV2Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.
IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.
For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateServiceRoleToAccount
(Consumer<AssociateServiceRoleToAccountRequest.Builder> associateServiceRoleToAccountRequest) Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.associateServiceRoleToAccount
(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest) Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.batchAssociateClientDeviceWithCoreDevice
(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest) Associates a list of client devices with a core device.batchAssociateClientDeviceWithCoreDevice
(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest) Associates a list of client devices with a core device.batchDisassociateClientDeviceFromCoreDevice
(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest) Disassociates a list of client devices from a core device.batchDisassociateClientDeviceFromCoreDevice
(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest) Disassociates a list of client devices from a core device.static GreengrassV2ClientBuilder
builder()
Create a builder that can be used to configure and create aGreengrassV2Client
.default CancelDeploymentResponse
cancelDeployment
(Consumer<CancelDeploymentRequest.Builder> cancelDeploymentRequest) Cancels a deployment.default CancelDeploymentResponse
cancelDeployment
(CancelDeploymentRequest cancelDeploymentRequest) Cancels a deployment.static GreengrassV2Client
create()
Create aGreengrassV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateComponentVersionResponse
createComponentVersion
(Consumer<CreateComponentVersionRequest.Builder> createComponentVersionRequest) Creates a component.default CreateComponentVersionResponse
createComponentVersion
(CreateComponentVersionRequest createComponentVersionRequest) Creates a component.default CreateDeploymentResponse
createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.default CreateDeploymentResponse
createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.default DeleteComponentResponse
deleteComponent
(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) Deletes a version of a component from IoT Greengrass.default DeleteComponentResponse
deleteComponent
(DeleteComponentRequest deleteComponentRequest) Deletes a version of a component from IoT Greengrass.default DeleteCoreDeviceResponse
deleteCoreDevice
(Consumer<DeleteCoreDeviceRequest.Builder> deleteCoreDeviceRequest) Deletes a Greengrass core device, which is an IoT thing.default DeleteCoreDeviceResponse
deleteCoreDevice
(DeleteCoreDeviceRequest deleteCoreDeviceRequest) Deletes a Greengrass core device, which is an IoT thing.default DeleteDeploymentResponse
deleteDeployment
(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest) Deletes a deployment.default DeleteDeploymentResponse
deleteDeployment
(DeleteDeploymentRequest deleteDeploymentRequest) Deletes a deployment.default DescribeComponentResponse
describeComponent
(Consumer<DescribeComponentRequest.Builder> describeComponentRequest) Retrieves metadata for a version of a component.default DescribeComponentResponse
describeComponent
(DescribeComponentRequest describeComponentRequest) Retrieves metadata for a version of a component.disassociateServiceRoleFromAccount
(Consumer<DisassociateServiceRoleFromAccountRequest.Builder> disassociateServiceRoleFromAccountRequest) Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.disassociateServiceRoleFromAccount
(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest) Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.default GetComponentResponse
getComponent
(Consumer<GetComponentRequest.Builder> getComponentRequest) Gets the recipe for a version of a component.default GetComponentResponse
getComponent
(GetComponentRequest getComponentRequest) Gets the recipe for a version of a component.getComponentVersionArtifact
(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest) Gets the pre-signed URL to download a public or a Lambda component artifact.getComponentVersionArtifact
(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest) Gets the pre-signed URL to download a public or a Lambda component artifact.default GetConnectivityInfoResponse
getConnectivityInfo
(Consumer<GetConnectivityInfoRequest.Builder> getConnectivityInfoRequest) Retrieves connectivity information for a Greengrass core device.default GetConnectivityInfoResponse
getConnectivityInfo
(GetConnectivityInfoRequest getConnectivityInfoRequest) Retrieves connectivity information for a Greengrass core device.default GetCoreDeviceResponse
getCoreDevice
(Consumer<GetCoreDeviceRequest.Builder> getCoreDeviceRequest) Retrieves metadata for a Greengrass core device.default GetCoreDeviceResponse
getCoreDevice
(GetCoreDeviceRequest getCoreDeviceRequest) Retrieves metadata for a Greengrass core device.default GetDeploymentResponse
getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets a deployment.default GetDeploymentResponse
getDeployment
(GetDeploymentRequest getDeploymentRequest) Gets a deployment.default GetServiceRoleForAccountResponse
getServiceRoleForAccount
(Consumer<GetServiceRoleForAccountRequest.Builder> getServiceRoleForAccountRequest) Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.default GetServiceRoleForAccountResponse
getServiceRoleForAccount
(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest) Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.listClientDevicesAssociatedWithCoreDevice
(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest) Retrieves a paginated list of client devices that are associated with a core device.listClientDevicesAssociatedWithCoreDevice
(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest) Retrieves a paginated list of client devices that are associated with a core device.listClientDevicesAssociatedWithCoreDevicePaginator
(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest) listClientDevicesAssociatedWithCoreDevicePaginator
(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest) default ListComponentsResponse
listComponents
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) Retrieves a paginated list of component summaries.default ListComponentsResponse
listComponents
(ListComponentsRequest listComponentsRequest) Retrieves a paginated list of component summaries.default ListComponentsIterable
listComponentsPaginator
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
operation.default ListComponentsIterable
listComponentsPaginator
(ListComponentsRequest listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
operation.default ListComponentVersionsResponse
listComponentVersions
(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest) Retrieves a paginated list of all versions for a component.default ListComponentVersionsResponse
listComponentVersions
(ListComponentVersionsRequest listComponentVersionsRequest) Retrieves a paginated list of all versions for a component.default ListComponentVersionsIterable
listComponentVersionsPaginator
(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest) This is a variant oflistComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation.default ListComponentVersionsIterable
listComponentVersionsPaginator
(ListComponentVersionsRequest listComponentVersionsRequest) This is a variant oflistComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation.default ListCoreDevicesResponse
listCoreDevices
(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) Retrieves a paginated list of Greengrass core devices.default ListCoreDevicesResponse
listCoreDevices
(ListCoreDevicesRequest listCoreDevicesRequest) Retrieves a paginated list of Greengrass core devices.default ListCoreDevicesIterable
listCoreDevicesPaginator
(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) This is a variant oflistCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
operation.default ListCoreDevicesIterable
listCoreDevicesPaginator
(ListCoreDevicesRequest listCoreDevicesRequest) This is a variant oflistCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
operation.default ListDeploymentsResponse
listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Retrieves a paginated list of deployments.default ListDeploymentsResponse
listDeployments
(ListDeploymentsRequest listDeploymentsRequest) Retrieves a paginated list of deployments.default ListDeploymentsIterable
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
operation.default ListDeploymentsIterable
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
operation.default ListEffectiveDeploymentsResponse
listEffectiveDeployments
(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest) Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.default ListEffectiveDeploymentsResponse
listEffectiveDeployments
(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest) Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.default ListEffectiveDeploymentsIterable
listEffectiveDeploymentsPaginator
(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest) This is a variant oflistEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation.default ListEffectiveDeploymentsIterable
listEffectiveDeploymentsPaginator
(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest) This is a variant oflistEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation.default ListInstalledComponentsResponse
listInstalledComponents
(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest) Retrieves a paginated list of the components that a Greengrass core device runs.default ListInstalledComponentsResponse
listInstalledComponents
(ListInstalledComponentsRequest listInstalledComponentsRequest) Retrieves a paginated list of the components that a Greengrass core device runs.default ListInstalledComponentsIterable
listInstalledComponentsPaginator
(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest) This is a variant oflistInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation.default ListInstalledComponentsIterable
listInstalledComponentsPaginator
(ListInstalledComponentsRequest listInstalledComponentsRequest) This is a variant oflistInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of tags for an IoT Greengrass resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags for an IoT Greengrass resource.resolveComponentCandidates
(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest) Retrieves a list of components that meet the component, version, and platform requirements of a deployment.resolveComponentCandidates
(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest) Retrieves a list of components that meet the component, version, and platform requirements of a deployment.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to an IoT Greengrass resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds tags to an IoT Greengrass resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from an IoT Greengrass resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from an IoT Greengrass resource.default UpdateConnectivityInfoResponse
updateConnectivityInfo
(Consumer<UpdateConnectivityInfoRequest.Builder> updateConnectivityInfoRequest) Updates connectivity information for a Greengrass core device.default UpdateConnectivityInfoResponse
updateConnectivityInfo
(UpdateConnectivityInfoRequest updateConnectivityInfoRequest) Updates connectivity information for a Greengrass core device.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
associateServiceRoleToAccount
default AssociateServiceRoleToAccountResponse associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
- Parameters:
associateServiceRoleToAccountRequest
-- Returns:
- Result of the AssociateServiceRoleToAccount operation returned by the service.
- See Also:
-
associateServiceRoleToAccount
default AssociateServiceRoleToAccountResponse associateServiceRoleToAccount(Consumer<AssociateServiceRoleToAccountRequest.Builder> associateServiceRoleToAccountRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
This is a convenience which creates an instance of the
AssociateServiceRoleToAccountRequest.Builder
avoiding the need to create one manually viaAssociateServiceRoleToAccountRequest.builder()
- Parameters:
associateServiceRoleToAccountRequest
- AConsumer
that will call methods onAssociateServiceRoleToAccountRequest.Builder
to create a request.- Returns:
- Result of the AssociateServiceRoleToAccount operation returned by the service.
- See Also:
-
batchAssociateClientDeviceWithCoreDevice
default BatchAssociateClientDeviceWithCoreDeviceResponse batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.
Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
- Parameters:
batchAssociateClientDeviceWithCoreDeviceRequest
-- Returns:
- Result of the BatchAssociateClientDeviceWithCoreDevice operation returned by the service.
- See Also:
-
batchAssociateClientDeviceWithCoreDevice
default BatchAssociateClientDeviceWithCoreDeviceResponse batchAssociateClientDeviceWithCoreDevice(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.
Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
This is a convenience which creates an instance of the
BatchAssociateClientDeviceWithCoreDeviceRequest.Builder
avoiding the need to create one manually viaBatchAssociateClientDeviceWithCoreDeviceRequest.builder()
- Parameters:
batchAssociateClientDeviceWithCoreDeviceRequest
- AConsumer
that will call methods onBatchAssociateClientDeviceWithCoreDeviceRequest.Builder
to create a request.- Returns:
- Result of the BatchAssociateClientDeviceWithCoreDevice operation returned by the service.
- See Also:
-
batchDisassociateClientDeviceFromCoreDevice
default BatchDisassociateClientDeviceFromCoreDeviceResponse batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
- Parameters:
batchDisassociateClientDeviceFromCoreDeviceRequest
-- Returns:
- Result of the BatchDisassociateClientDeviceFromCoreDevice operation returned by the service.
- See Also:
-
batchDisassociateClientDeviceFromCoreDevice
default BatchDisassociateClientDeviceFromCoreDeviceResponse batchDisassociateClientDeviceFromCoreDevice(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
This is a convenience which creates an instance of the
BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder
avoiding the need to create one manually viaBatchDisassociateClientDeviceFromCoreDeviceRequest.builder()
- Parameters:
batchDisassociateClientDeviceFromCoreDeviceRequest
- AConsumer
that will call methods onBatchDisassociateClientDeviceFromCoreDeviceRequest.Builder
to create a request.- Returns:
- Result of the BatchDisassociateClientDeviceFromCoreDevice operation returned by the service.
- See Also:
-
cancelDeployment
default CancelDeploymentResponse cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.
- Parameters:
cancelDeploymentRequest
-- Returns:
- Result of the CancelDeployment operation returned by the service.
- See Also:
-
cancelDeployment
default CancelDeploymentResponse cancelDeployment(Consumer<CancelDeploymentRequest.Builder> cancelDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.
This is a convenience which creates an instance of the
CancelDeploymentRequest.Builder
avoiding the need to create one manually viaCancelDeploymentRequest.builder()
- Parameters:
cancelDeploymentRequest
- AConsumer
that will call methods onCancelDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CancelDeployment operation returned by the service.
- See Also:
-
createComponentVersion
default CreateComponentVersionResponse createComponentVersion(CreateComponentVersionRequest createComponentVersionRequest) throws ValidationException, ServiceQuotaExceededException, AccessDeniedException, ConflictException, ThrottlingException, InternalServerException, RequestAlreadyInProgressException, AwsServiceException, SdkClientException, GreengrassV2Exception Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.
You can use this operation to do the following:
-
Create components from recipes
Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide.
To create a component from a recipe, specify
inlineRecipe
when you call this operation. -
Create components from Lambda functions
Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.
This function only accepts Lambda functions that use the following runtimes:
-
Python 2.7 –
python2.7
-
Python 3.7 –
python3.7
-
Python 3.8 –
python3.8
-
Python 3.9 –
python3.9
-
Java 8 –
java8
-
Java 11 –
java11
-
Node.js 10 –
nodejs10.x
-
Node.js 12 –
nodejs12.x
-
Node.js 14 –
nodejs14.x
To create a component from a Lambda function, specify
lambdaFunction
when you call this operation.IoT Greengrass currently supports Lambda functions on only Linux core devices.
-
- Parameters:
createComponentVersionRequest
-- Returns:
- Result of the CreateComponentVersion operation returned by the service.
- See Also:
-
-
createComponentVersion
default CreateComponentVersionResponse createComponentVersion(Consumer<CreateComponentVersionRequest.Builder> createComponentVersionRequest) throws ValidationException, ServiceQuotaExceededException, AccessDeniedException, ConflictException, ThrottlingException, InternalServerException, RequestAlreadyInProgressException, AwsServiceException, SdkClientException, GreengrassV2Exception Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.
You can use this operation to do the following:
-
Create components from recipes
Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide.
To create a component from a recipe, specify
inlineRecipe
when you call this operation. -
Create components from Lambda functions
Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.
This function only accepts Lambda functions that use the following runtimes:
-
Python 2.7 –
python2.7
-
Python 3.7 –
python3.7
-
Python 3.8 –
python3.8
-
Python 3.9 –
python3.9
-
Java 8 –
java8
-
Java 11 –
java11
-
Node.js 10 –
nodejs10.x
-
Node.js 12 –
nodejs12.x
-
Node.js 14 –
nodejs14.x
To create a component from a Lambda function, specify
lambdaFunction
when you call this operation.IoT Greengrass currently supports Lambda functions on only Linux core devices.
-
This is a convenience which creates an instance of the
CreateComponentVersionRequest.Builder
avoiding the need to create one manually viaCreateComponentVersionRequest.builder()
- Parameters:
createComponentVersionRequest
- AConsumer
that will call methods onCreateComponentVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateComponentVersion operation returned by the service.
- See Also:
-
-
createDeployment
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, ConflictException, RequestAlreadyInProgressException, AwsServiceException, SdkClientException, GreengrassV2Exception Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
- Parameters:
createDeploymentRequest
-- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
createDeployment
default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, ConflictException, RequestAlreadyInProgressException, AwsServiceException, SdkClientException, GreengrassV2Exception Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builder
avoiding the need to create one manually viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(DeleteComponentRequest deleteComponentRequest) throws ValidationException, AccessDeniedException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a version of a component from IoT Greengrass.
This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
- Parameters:
deleteComponentRequest
-- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) throws ValidationException, AccessDeniedException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a version of a component from IoT Greengrass.
This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
This is a convenience which creates an instance of the
DeleteComponentRequest.Builder
avoiding the need to create one manually viaDeleteComponentRequest.builder()
- Parameters:
deleteComponentRequest
- AConsumer
that will call methods onDeleteComponentRequest.Builder
to create a request.- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteCoreDevice
default DeleteCoreDeviceResponse deleteCoreDevice(DeleteCoreDeviceRequest deleteCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.
- Parameters:
deleteCoreDeviceRequest
-- Returns:
- Result of the DeleteCoreDevice operation returned by the service.
- See Also:
-
deleteCoreDevice
default DeleteCoreDeviceResponse deleteCoreDevice(Consumer<DeleteCoreDeviceRequest.Builder> deleteCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.
This is a convenience which creates an instance of the
DeleteCoreDeviceRequest.Builder
avoiding the need to create one manually viaDeleteCoreDeviceRequest.builder()
- Parameters:
deleteCoreDeviceRequest
- AConsumer
that will call methods onDeleteCoreDeviceRequest.Builder
to create a request.- Returns:
- Result of the DeleteCoreDevice operation returned by the service.
- See Also:
-
deleteDeployment
default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
- Parameters:
deleteDeploymentRequest
-- Returns:
- Result of the DeleteDeployment operation returned by the service.
- See Also:
-
deleteDeployment
default DeleteDeploymentResponse deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
This is a convenience which creates an instance of the
DeleteDeploymentRequest.Builder
avoiding the need to create one manually viaDeleteDeploymentRequest.builder()
- Parameters:
deleteDeploymentRequest
- AConsumer
that will call methods onDeleteDeploymentRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeployment operation returned by the service.
- See Also:
-
describeComponent
default DescribeComponentResponse describeComponent(DescribeComponentRequest describeComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves metadata for a version of a component.
- Parameters:
describeComponentRequest
-- Returns:
- Result of the DescribeComponent operation returned by the service.
- See Also:
-
describeComponent
default DescribeComponentResponse describeComponent(Consumer<DescribeComponentRequest.Builder> describeComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves metadata for a version of a component.
This is a convenience which creates an instance of the
DescribeComponentRequest.Builder
avoiding the need to create one manually viaDescribeComponentRequest.builder()
- Parameters:
describeComponentRequest
- AConsumer
that will call methods onDescribeComponentRequest.Builder
to create a request.- Returns:
- Result of the DescribeComponent operation returned by the service.
- See Also:
-
disassociateServiceRoleFromAccount
default DisassociateServiceRoleFromAccountResponse disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest) throws InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
- Parameters:
disassociateServiceRoleFromAccountRequest
-- Returns:
- Result of the DisassociateServiceRoleFromAccount operation returned by the service.
- See Also:
-
disassociateServiceRoleFromAccount
default DisassociateServiceRoleFromAccountResponse disassociateServiceRoleFromAccount(Consumer<DisassociateServiceRoleFromAccountRequest.Builder> disassociateServiceRoleFromAccountRequest) throws InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
This is a convenience which creates an instance of the
DisassociateServiceRoleFromAccountRequest.Builder
avoiding the need to create one manually viaDisassociateServiceRoleFromAccountRequest.builder()
- Parameters:
disassociateServiceRoleFromAccountRequest
- AConsumer
that will call methods onDisassociateServiceRoleFromAccountRequest.Builder
to create a request.- Returns:
- Result of the DisassociateServiceRoleFromAccount operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the recipe for a version of a component.
- Parameters:
getComponentRequest
-- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the recipe for a version of a component.
This is a convenience which creates an instance of the
GetComponentRequest.Builder
avoiding the need to create one manually viaGetComponentRequest.builder()
- Parameters:
getComponentRequest
- AConsumer
that will call methods onGetComponentRequest.Builder
to create a request.- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getComponentVersionArtifact
default GetComponentVersionArtifactResponse getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
- Parameters:
getComponentVersionArtifactRequest
-- Returns:
- Result of the GetComponentVersionArtifact operation returned by the service.
- See Also:
-
getComponentVersionArtifact
default GetComponentVersionArtifactResponse getComponentVersionArtifact(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
This is a convenience which creates an instance of the
GetComponentVersionArtifactRequest.Builder
avoiding the need to create one manually viaGetComponentVersionArtifactRequest.builder()
- Parameters:
getComponentVersionArtifactRequest
- AConsumer
that will call methods onGetComponentVersionArtifactRequest.Builder
to create a request.- Returns:
- Result of the GetComponentVersionArtifact operation returned by the service.
- See Also:
-
getConnectivityInfo
default GetConnectivityInfoResponse getConnectivityInfo(GetConnectivityInfoRequest getConnectivityInfoRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
- Parameters:
getConnectivityInfoRequest
-- Returns:
- Result of the GetConnectivityInfo operation returned by the service.
- See Also:
-
getConnectivityInfo
default GetConnectivityInfoResponse getConnectivityInfo(Consumer<GetConnectivityInfoRequest.Builder> getConnectivityInfoRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
This is a convenience which creates an instance of the
GetConnectivityInfoRequest.Builder
avoiding the need to create one manually viaGetConnectivityInfoRequest.builder()
- Parameters:
getConnectivityInfoRequest
- AConsumer
that will call methods onGetConnectivityInfoRequest.Builder
to create a request.- Returns:
- Result of the GetConnectivityInfo operation returned by the service.
- See Also:
-
getCoreDevice
default GetCoreDeviceResponse getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves metadata for a Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
- Parameters:
getCoreDeviceRequest
-- Returns:
- Result of the GetCoreDevice operation returned by the service.
- See Also:
-
-
getCoreDevice
default GetCoreDeviceResponse getCoreDevice(Consumer<GetCoreDeviceRequest.Builder> getCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves metadata for a Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
This is a convenience which creates an instance of the
GetCoreDeviceRequest.Builder
avoiding the need to create one manually viaGetCoreDeviceRequest.builder()
- Parameters:
getCoreDeviceRequest
- AConsumer
that will call methods onGetCoreDeviceRequest.Builder
to create a request.- Returns:
- Result of the GetCoreDevice operation returned by the service.
- See Also:
-
-
getDeployment
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets a deployment. Deployments define the components that run on Greengrass core devices.
- Parameters:
getDeploymentRequest
-- Returns:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getDeployment
default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets a deployment. Deployments define the components that run on Greengrass core devices.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builder
avoiding the need to create one manually viaGetDeploymentRequest.builder()
- Parameters:
getDeploymentRequest
- AConsumer
that will call methods onGetDeploymentRequest.Builder
to create a request.- Returns:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getServiceRoleForAccount
default GetServiceRoleForAccountResponse getServiceRoleForAccount(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest) throws InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
- Parameters:
getServiceRoleForAccountRequest
-- Returns:
- Result of the GetServiceRoleForAccount operation returned by the service.
- See Also:
-
getServiceRoleForAccount
default GetServiceRoleForAccountResponse getServiceRoleForAccount(Consumer<GetServiceRoleForAccountRequest.Builder> getServiceRoleForAccountRequest) throws InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
This is a convenience which creates an instance of the
GetServiceRoleForAccountRequest.Builder
avoiding the need to create one manually viaGetServiceRoleForAccountRequest.builder()
- Parameters:
getServiceRoleForAccountRequest
- AConsumer
that will call methods onGetServiceRoleForAccountRequest.Builder
to create a request.- Returns:
- Result of the GetServiceRoleForAccount operation returned by the service.
- See Also:
-
listClientDevicesAssociatedWithCoreDevice
default ListClientDevicesAssociatedWithCoreDeviceResponse listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of client devices that are associated with a core device.
- Parameters:
listClientDevicesAssociatedWithCoreDeviceRequest
-- Returns:
- Result of the ListClientDevicesAssociatedWithCoreDevice operation returned by the service.
- See Also:
-
listClientDevicesAssociatedWithCoreDevice
default ListClientDevicesAssociatedWithCoreDeviceResponse listClientDevicesAssociatedWithCoreDevice(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of client devices that are associated with a core device.
This is a convenience which creates an instance of the
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder
avoiding the need to create one manually viaListClientDevicesAssociatedWithCoreDeviceRequest.builder()
- Parameters:
listClientDevicesAssociatedWithCoreDeviceRequest
- AConsumer
that will call methods onListClientDevicesAssociatedWithCoreDeviceRequest.Builder
to create a request.- Returns:
- Result of the ListClientDevicesAssociatedWithCoreDevice operation returned by the service.
- See Also:
-
listClientDevicesAssociatedWithCoreDevicePaginator
default ListClientDevicesAssociatedWithCoreDeviceIterable listClientDevicesAssociatedWithCoreDevicePaginator(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client .listClientDevicesAssociatedWithCoreDevicePaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(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
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
operation.- Parameters:
listClientDevicesAssociatedWithCoreDeviceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClientDevicesAssociatedWithCoreDevicePaginator
default ListClientDevicesAssociatedWithCoreDeviceIterable listClientDevicesAssociatedWithCoreDevicePaginator(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client .listClientDevicesAssociatedWithCoreDevicePaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(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
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
operation.
This is a convenience which creates an instance of the
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder
avoiding the need to create one manually viaListClientDevicesAssociatedWithCoreDeviceRequest.builder()
- Parameters:
listClientDevicesAssociatedWithCoreDeviceRequest
- AConsumer
that will call methods onListClientDevicesAssociatedWithCoreDeviceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentVersions
default ListComponentVersionsResponse listComponentVersions(ListComponentVersionsRequest listComponentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of all versions for a component. Greater versions are listed first.
- Parameters:
listComponentVersionsRequest
-- Returns:
- Result of the ListComponentVersions operation returned by the service.
- See Also:
-
listComponentVersions
default ListComponentVersionsResponse listComponentVersions(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of all versions for a component. Greater versions are listed first.
This is a convenience which creates an instance of the
ListComponentVersionsRequest.Builder
avoiding the need to create one manually viaListComponentVersionsRequest.builder()
- Parameters:
listComponentVersionsRequest
- AConsumer
that will call methods onListComponentVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListComponentVersions operation returned by the service.
- See Also:
-
listComponentVersionsPaginator
default ListComponentVersionsIterable listComponentVersionsPaginator(ListComponentVersionsRequest listComponentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client .listComponentVersionsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(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
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation.- Parameters:
listComponentVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentVersionsPaginator
default ListComponentVersionsIterable listComponentVersionsPaginator(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client .listComponentVersionsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(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
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentVersionsRequest.Builder
avoiding the need to create one manually viaListComponentVersionsRequest.builder()
- Parameters:
listComponentVersionsRequest
- AConsumer
that will call methods onListComponentVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
- Parameters:
listComponentsRequest
-- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(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
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
operation.- Parameters:
listComponentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(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
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCoreDevices
default ListCoreDevicesResponse listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of Greengrass core devices.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
- Parameters:
listCoreDevicesRequest
-- Returns:
- Result of the ListCoreDevices operation returned by the service.
- See Also:
-
-
listCoreDevices
default ListCoreDevicesResponse listCoreDevices(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of Greengrass core devices.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
This is a convenience which creates an instance of the
ListCoreDevicesRequest.Builder
avoiding the need to create one manually viaListCoreDevicesRequest.builder()
- Parameters:
listCoreDevicesRequest
- AConsumer
that will call methods onListCoreDevicesRequest.Builder
to create a request.- Returns:
- Result of the ListCoreDevices operation returned by the service.
- See Also:
-
-
listCoreDevicesPaginator
default ListCoreDevicesIterable listCoreDevicesPaginator(ListCoreDevicesRequest listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client .listCoreDevicesPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(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
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
operation.- Parameters:
listCoreDevicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCoreDevicesPaginator
default ListCoreDevicesIterable listCoreDevicesPaginator(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client .listCoreDevicesPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(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
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest)
operation.
This is a convenience which creates an instance of the
ListCoreDevicesRequest.Builder
avoiding the need to create one manually viaListCoreDevicesRequest.builder()
- Parameters:
listCoreDevicesRequest
- AConsumer
that will call methods onListCoreDevicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of deployments.
- Parameters:
listDeploymentsRequest
-- Returns:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of deployments.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(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
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(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
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEffectiveDeployments
default ListEffectiveDeploymentsResponse listEffectiveDeployments(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
- Parameters:
listEffectiveDeploymentsRequest
-- Returns:
- Result of the ListEffectiveDeployments operation returned by the service.
- See Also:
-
listEffectiveDeployments
default ListEffectiveDeploymentsResponse listEffectiveDeployments(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
This is a convenience which creates an instance of the
ListEffectiveDeploymentsRequest.Builder
avoiding the need to create one manually viaListEffectiveDeploymentsRequest.builder()
- Parameters:
listEffectiveDeploymentsRequest
- AConsumer
that will call methods onListEffectiveDeploymentsRequest.Builder
to create a request.- Returns:
- Result of the ListEffectiveDeployments operation returned by the service.
- See Also:
-
listEffectiveDeploymentsPaginator
default ListEffectiveDeploymentsIterable listEffectiveDeploymentsPaginator(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client .listEffectiveDeploymentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(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
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation.- Parameters:
listEffectiveDeploymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEffectiveDeploymentsPaginator
default ListEffectiveDeploymentsIterable listEffectiveDeploymentsPaginator(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client .listEffectiveDeploymentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(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
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListEffectiveDeploymentsRequest.Builder
avoiding the need to create one manually viaListEffectiveDeploymentsRequest.builder()
- Parameters:
listEffectiveDeploymentsRequest
- AConsumer
that will call methods onListEffectiveDeploymentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInstalledComponents
default ListInstalledComponentsResponse listInstalledComponents(ListInstalledComponentsRequest listInstalledComponentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the
topologyFilter
parameter toALL
.IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
- Parameters:
listInstalledComponentsRequest
-- Returns:
- Result of the ListInstalledComponents operation returned by the service.
- See Also:
-
-
listInstalledComponents
default ListInstalledComponentsResponse listInstalledComponents(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the
topologyFilter
parameter toALL
.IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
-
When the IoT Greengrass Core software starts
-
When the core device receives a deployment from the Amazon Web Services Cloud
-
When the status of any component on the core device becomes
BROKEN
-
At a regular interval that you can configure, which defaults to 24 hours
-
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
This is a convenience which creates an instance of the
ListInstalledComponentsRequest.Builder
avoiding the need to create one manually viaListInstalledComponentsRequest.builder()
- Parameters:
listInstalledComponentsRequest
- AConsumer
that will call methods onListInstalledComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListInstalledComponents operation returned by the service.
- See Also:
-
-
listInstalledComponentsPaginator
default ListInstalledComponentsIterable listInstalledComponentsPaginator(ListInstalledComponentsRequest listInstalledComponentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client .listInstalledComponentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(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
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation.- Parameters:
listInstalledComponentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInstalledComponentsPaginator
default ListInstalledComponentsIterable listInstalledComponentsPaginator(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception This is a variant of
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
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 Streamsoftware.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client .listInstalledComponentsPaginator(request); for (software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(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
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListInstalledComponentsRequest.Builder
avoiding the need to create one manually viaListInstalledComponentsRequest.builder()
- Parameters:
listInstalledComponentsRequest
- AConsumer
that will call methods onListInstalledComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves the list of tags for an IoT Greengrass resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves the list of tags for an IoT Greengrass resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
resolveComponentCandidates
default ResolveComponentCandidatesResponse resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component
A
requires version>2.0.0
and componentB
requires version<2.0.0
of a component dependency.When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.
- Parameters:
resolveComponentCandidatesRequest
-- Returns:
- Result of the ResolveComponentCandidates operation returned by the service.
- See Also:
-
resolveComponentCandidates
default ResolveComponentCandidatesResponse resolveComponentCandidates(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component
A
requires version>2.0.0
and componentB
requires version<2.0.0
of a component dependency.When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.
This is a convenience which creates an instance of the
ResolveComponentCandidatesRequest.Builder
avoiding the need to create one manually viaResolveComponentCandidatesRequest.builder()
- Parameters:
resolveComponentCandidatesRequest
- AConsumer
that will call methods onResolveComponentCandidatesRequest.Builder
to create a request.- Returns:
- Result of the ResolveComponentCandidates operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Removes a tag from an IoT Greengrass resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception Removes a tag from an IoT Greengrass resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateConnectivityInfo
default UpdateConnectivityInfoResponse updateConnectivityInfo(UpdateConnectivityInfoRequest updateConnectivityInfoRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Updates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
- Parameters:
updateConnectivityInfoRequest
-- Returns:
- Result of the UpdateConnectivityInfo operation returned by the service.
- See Also:
-
updateConnectivityInfo
default UpdateConnectivityInfoResponse updateConnectivityInfo(Consumer<UpdateConnectivityInfoRequest.Builder> updateConnectivityInfoRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception Updates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
This is a convenience which creates an instance of the
UpdateConnectivityInfoRequest.Builder
avoiding the need to create one manually viaUpdateConnectivityInfoRequest.builder()
- Parameters:
updateConnectivityInfoRequest
- AConsumer
that will call methods onUpdateConnectivityInfoRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnectivityInfo operation returned by the service.
- See Also:
-
create
Create aGreengrassV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGreengrassV2Client
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-