@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GreengrassV2AsyncClient extends 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<BatchAssociateClientDeviceWithCoreDeviceResponse> |
batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest)
Associate a list of client devices with a core device.
|
default CompletableFuture<BatchAssociateClientDeviceWithCoreDeviceResponse> |
batchAssociateClientDeviceWithCoreDevice(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest)
Associate a list of client devices with a core device.
|
default CompletableFuture<BatchDisassociateClientDeviceFromCoreDeviceResponse> |
batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate a list of client devices from a core device.
|
default CompletableFuture<BatchDisassociateClientDeviceFromCoreDeviceResponse> |
batchDisassociateClientDeviceFromCoreDevice(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate a list of client devices from a core device.
|
static GreengrassV2AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
GreengrassV2AsyncClient. |
default CompletableFuture<CancelDeploymentResponse> |
cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest)
Cancels a deployment.
|
default CompletableFuture<CancelDeploymentResponse> |
cancelDeployment(Consumer<CancelDeploymentRequest.Builder> cancelDeploymentRequest)
Cancels a deployment.
|
static GreengrassV2AsyncClient |
create()
Create a
GreengrassV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateComponentVersionResponse> |
createComponentVersion(Consumer<CreateComponentVersionRequest.Builder> createComponentVersionRequest)
Creates a component.
|
default CompletableFuture<CreateComponentVersionResponse> |
createComponentVersion(CreateComponentVersionRequest createComponentVersionRequest)
Creates a component.
|
default CompletableFuture<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 CompletableFuture<CreateDeploymentResponse> |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.
|
default CompletableFuture<DeleteComponentResponse> |
deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest)
Deletes a version of a component from IoT Greengrass.
|
default CompletableFuture<DeleteComponentResponse> |
deleteComponent(DeleteComponentRequest deleteComponentRequest)
Deletes a version of a component from IoT Greengrass.
|
default CompletableFuture<DeleteCoreDeviceResponse> |
deleteCoreDevice(Consumer<DeleteCoreDeviceRequest.Builder> deleteCoreDeviceRequest)
Deletes a Greengrass core device, which is an IoT thing.
|
default CompletableFuture<DeleteCoreDeviceResponse> |
deleteCoreDevice(DeleteCoreDeviceRequest deleteCoreDeviceRequest)
Deletes a Greengrass core device, which is an IoT thing.
|
default CompletableFuture<DescribeComponentResponse> |
describeComponent(Consumer<DescribeComponentRequest.Builder> describeComponentRequest)
Retrieves metadata for a version of a component.
|
default CompletableFuture<DescribeComponentResponse> |
describeComponent(DescribeComponentRequest describeComponentRequest)
Retrieves metadata for a version of a component.
|
default CompletableFuture<GetComponentResponse> |
getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)
Gets the recipe for a version of a component.
|
default CompletableFuture<GetComponentResponse> |
getComponent(GetComponentRequest getComponentRequest)
Gets the recipe for a version of a component.
|
default CompletableFuture<GetComponentVersionArtifactResponse> |
getComponentVersionArtifact(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public component artifact.
|
default CompletableFuture<GetComponentVersionArtifactResponse> |
getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public component artifact.
|
default CompletableFuture<GetCoreDeviceResponse> |
getCoreDevice(Consumer<GetCoreDeviceRequest.Builder> getCoreDeviceRequest)
Retrieves metadata for a Greengrass core device.
|
default CompletableFuture<GetCoreDeviceResponse> |
getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest)
Retrieves metadata for a Greengrass core device.
|
default CompletableFuture<GetDeploymentResponse> |
getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
Gets a deployment.
|
default CompletableFuture<GetDeploymentResponse> |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets a deployment.
|
default CompletableFuture<ListClientDevicesAssociatedWithCoreDeviceResponse> |
listClientDevicesAssociatedWithCoreDevice(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default CompletableFuture<ListClientDevicesAssociatedWithCoreDeviceResponse> |
listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default ListClientDevicesAssociatedWithCoreDevicePublisher |
listClientDevicesAssociatedWithCoreDevicePaginator(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default ListClientDevicesAssociatedWithCoreDevicePublisher |
listClientDevicesAssociatedWithCoreDevicePaginator(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default CompletableFuture<ListComponentsResponse> |
listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
Retrieves a paginated list of component summaries.
|
default CompletableFuture<ListComponentsResponse> |
listComponents(ListComponentsRequest listComponentsRequest)
Retrieves a paginated list of component summaries.
|
default ListComponentsPublisher |
listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
Retrieves a paginated list of component summaries.
|
default ListComponentsPublisher |
listComponentsPaginator(ListComponentsRequest listComponentsRequest)
Retrieves a paginated list of component summaries.
|
default CompletableFuture<ListComponentVersionsResponse> |
listComponentVersions(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component.
|
default CompletableFuture<ListComponentVersionsResponse> |
listComponentVersions(ListComponentVersionsRequest listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component.
|
default ListComponentVersionsPublisher |
listComponentVersionsPaginator(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component.
|
default ListComponentVersionsPublisher |
listComponentVersionsPaginator(ListComponentVersionsRequest listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component.
|
default CompletableFuture<ListCoreDevicesResponse> |
listCoreDevices(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
|
default CompletableFuture<ListCoreDevicesResponse> |
listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
|
default ListCoreDevicesPublisher |
listCoreDevicesPaginator(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
|
default ListCoreDevicesPublisher |
listCoreDevicesPaginator(ListCoreDevicesRequest listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
|
default CompletableFuture<ListDeploymentsResponse> |
listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
Retrieves a paginated list of deployments.
|
default CompletableFuture<ListDeploymentsResponse> |
listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Retrieves a paginated list of deployments.
|
default ListDeploymentsPublisher |
listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
Retrieves a paginated list of deployments.
|
default ListDeploymentsPublisher |
listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)
Retrieves a paginated list of deployments.
|
default CompletableFuture<ListEffectiveDeploymentsResponse> |
listEffectiveDeployments(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
default CompletableFuture<ListEffectiveDeploymentsResponse> |
listEffectiveDeployments(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
default ListEffectiveDeploymentsPublisher |
listEffectiveDeploymentsPaginator(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
default ListEffectiveDeploymentsPublisher |
listEffectiveDeploymentsPaginator(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
default CompletableFuture<ListInstalledComponentsResponse> |
listInstalledComponents(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
default CompletableFuture<ListInstalledComponentsResponse> |
listInstalledComponents(ListInstalledComponentsRequest listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
default ListInstalledComponentsPublisher |
listInstalledComponentsPaginator(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
default ListInstalledComponentsPublisher |
listInstalledComponentsPaginator(ListInstalledComponentsRequest listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves the list of tags for an IoT Greengrass resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an IoT Greengrass resource.
|
default CompletableFuture<ResolveComponentCandidatesResponse> |
resolveComponentCandidates(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest)
Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
|
default CompletableFuture<ResolveComponentCandidatesResponse> |
resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest)
Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to an IoT Greengrass resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an IoT Greengrass resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an IoT Greengrass resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an IoT Greengrass resource.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static GreengrassV2AsyncClient create()
GreengrassV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GreengrassV2AsyncClientBuilder builder()
GreengrassV2AsyncClient.default CompletableFuture<BatchAssociateClientDeviceWithCoreDeviceResponse> batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest)
Associate 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.
batchAssociateClientDeviceWithCoreDeviceRequest - default CompletableFuture<BatchAssociateClientDeviceWithCoreDeviceResponse> batchAssociateClientDeviceWithCoreDevice(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest)
Associate 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 via
BatchAssociateClientDeviceWithCoreDeviceRequest.builder()
batchAssociateClientDeviceWithCoreDeviceRequest - A Consumer that will call methods on
BatchAssociateClientDeviceWithCoreDeviceRequest.Builder to create a request.default CompletableFuture<BatchDisassociateClientDeviceFromCoreDeviceResponse> batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate 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.
batchDisassociateClientDeviceFromCoreDeviceRequest - default CompletableFuture<BatchDisassociateClientDeviceFromCoreDeviceResponse> batchDisassociateClientDeviceFromCoreDevice(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate 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 via
BatchDisassociateClientDeviceFromCoreDeviceRequest.builder()
batchDisassociateClientDeviceFromCoreDeviceRequest - A Consumer that will call methods on
BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder to create a request.default CompletableFuture<CancelDeploymentResponse> cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest)
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.
cancelDeploymentRequest - default CompletableFuture<CancelDeploymentResponse> cancelDeployment(Consumer<CancelDeploymentRequest.Builder> cancelDeploymentRequest)
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 via CancelDeploymentRequest.builder()
cancelDeploymentRequest - A Consumer that will call methods on CancelDeploymentRequest.Builder to create a request.default CompletableFuture<CreateComponentVersionResponse> createComponentVersion(CreateComponentVersionRequest createComponentVersionRequest)
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
Java 8 – java8
Node.js 10 – nodejs10.x
Node.js 12 – nodejs12.x
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
createComponentVersionRequest - default CompletableFuture<CreateComponentVersionResponse> createComponentVersion(Consumer<CreateComponentVersionRequest.Builder> createComponentVersionRequest)
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
Java 8 – java8
Node.js 10 – nodejs10.x
Node.js 12 – nodejs12.x
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
This is a convenience which creates an instance of the CreateComponentVersionRequest.Builder avoiding the
need to create one manually via CreateComponentVersionRequest.builder()
createComponentVersionRequest - A Consumer that will call methods on CreateComponentVersionRequest.Builder to create a
request.default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)
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. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
createDeploymentRequest - default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
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. This operation returns the revision number of the new deployment when you create it.
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 via CreateDeploymentRequest.builder()
createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.default CompletableFuture<DeleteComponentResponse> deleteComponent(DeleteComponentRequest deleteComponentRequest)
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.
deleteComponentRequest - default CompletableFuture<DeleteComponentResponse> deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest)
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 via DeleteComponentRequest.builder()
deleteComponentRequest - A Consumer that will call methods on DeleteComponentRequest.Builder to create a request.default CompletableFuture<DeleteCoreDeviceResponse> deleteCoreDevice(DeleteCoreDeviceRequest deleteCoreDeviceRequest)
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.
deleteCoreDeviceRequest - default CompletableFuture<DeleteCoreDeviceResponse> deleteCoreDevice(Consumer<DeleteCoreDeviceRequest.Builder> deleteCoreDeviceRequest)
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 via DeleteCoreDeviceRequest.builder()
deleteCoreDeviceRequest - A Consumer that will call methods on DeleteCoreDeviceRequest.Builder to create a request.default CompletableFuture<DescribeComponentResponse> describeComponent(DescribeComponentRequest describeComponentRequest)
Retrieves metadata for a version of a component.
describeComponentRequest - default CompletableFuture<DescribeComponentResponse> describeComponent(Consumer<DescribeComponentRequest.Builder> describeComponentRequest)
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 via DescribeComponentRequest.builder()
describeComponentRequest - A Consumer that will call methods on DescribeComponentRequest.Builder to create a request.default CompletableFuture<GetComponentResponse> getComponent(GetComponentRequest getComponentRequest)
Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.
getComponentRequest - default CompletableFuture<GetComponentResponse> getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)
Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.
This is a convenience which creates an instance of the GetComponentRequest.Builder avoiding the need to
create one manually via GetComponentRequest.builder()
getComponentRequest - A Consumer that will call methods on GetComponentRequest.Builder to create a request.default CompletableFuture<GetComponentVersionArtifactResponse> getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
getComponentVersionArtifactRequest - default CompletableFuture<GetComponentVersionArtifactResponse> getComponentVersionArtifact(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public 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 via GetComponentVersionArtifactRequest.builder()
getComponentVersionArtifactRequest - A Consumer that will call methods on GetComponentVersionArtifactRequest.Builder to create
a request.default CompletableFuture<GetCoreDeviceResponse> getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest)
Retrieves metadata for a Greengrass core device.
getCoreDeviceRequest - default CompletableFuture<GetCoreDeviceResponse> getCoreDevice(Consumer<GetCoreDeviceRequest.Builder> getCoreDeviceRequest)
Retrieves metadata for a Greengrass core device.
This is a convenience which creates an instance of the GetCoreDeviceRequest.Builder avoiding the need to
create one manually via GetCoreDeviceRequest.builder()
getCoreDeviceRequest - A Consumer that will call methods on GetCoreDeviceRequest.Builder to create a request.default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets a deployment. Deployments define the components that run on Greengrass core devices.
getDeploymentRequest - default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
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 via GetDeploymentRequest.builder()
getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request.default CompletableFuture<ListClientDevicesAssociatedWithCoreDeviceResponse> listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
listClientDevicesAssociatedWithCoreDeviceRequest - default CompletableFuture<ListClientDevicesAssociatedWithCoreDeviceResponse> listClientDevicesAssociatedWithCoreDevice(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
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 via
ListClientDevicesAssociatedWithCoreDeviceRequest.builder()
listClientDevicesAssociatedWithCoreDeviceRequest - A Consumer that will call methods on
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder to create a request.default ListClientDevicesAssociatedWithCoreDevicePublisher listClientDevicesAssociatedWithCoreDevicePaginator(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
This is a variant of
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDevicePublisher publisher = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDevicePublisher publisher = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listClientDevicesAssociatedWithCoreDeviceRequest - default ListClientDevicesAssociatedWithCoreDevicePublisher listClientDevicesAssociatedWithCoreDevicePaginator(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
This is a variant of
listClientDevicesAssociatedWithCoreDevice(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDevicePublisher publisher = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDevicePublisher publisher = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListClientDevicesAssociatedWithCoreDeviceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via
ListClientDevicesAssociatedWithCoreDeviceRequest.builder()
listClientDevicesAssociatedWithCoreDeviceRequest - A Consumer that will call methods on
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder to create a request.default CompletableFuture<ListComponentVersionsResponse> listComponentVersions(ListComponentVersionsRequest listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component. Greater versions are listed first.
listComponentVersionsRequest - default CompletableFuture<ListComponentVersionsResponse> listComponentVersions(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest)
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 via ListComponentVersionsRequest.builder()
listComponentVersionsRequest - A Consumer that will call methods on ListComponentVersionsRequest.Builder to create a
request.default ListComponentVersionsPublisher listComponentVersionsPaginator(ListComponentVersionsRequest listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component. Greater versions are listed first.
This is a variant of
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsPublisher publisher = client.listComponentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsPublisher publisher = client.listComponentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listComponentVersionsRequest - default ListComponentVersionsPublisher listComponentVersionsPaginator(Consumer<ListComponentVersionsRequest.Builder> listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component. Greater versions are listed first.
This is a variant of
listComponentVersions(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsPublisher publisher = client.listComponentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsPublisher publisher = client.listComponentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListComponentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListComponentVersionsRequest.builder()
listComponentVersionsRequest - A Consumer that will call methods on ListComponentVersionsRequest.Builder to create a
request.default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest)
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
listComponentsRequest - default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
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 via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest)
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
This is a variant of
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listComponentsRequest - default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
This is a variant of
listComponents(software.amazon.awssdk.services.greengrassv2.model.ListComponentsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListComponentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.default CompletableFuture<ListCoreDevicesResponse> listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
listCoreDevicesRequest - default CompletableFuture<ListCoreDevicesResponse> listCoreDevices(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
This is a convenience which creates an instance of the ListCoreDevicesRequest.Builder avoiding the need
to create one manually via ListCoreDevicesRequest.builder()
listCoreDevicesRequest - A Consumer that will call methods on ListCoreDevicesRequest.Builder to create a request.default ListCoreDevicesPublisher listCoreDevicesPaginator(ListCoreDevicesRequest listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
This is a variant of
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesPublisher publisher = client.listCoreDevicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesPublisher publisher = client.listCoreDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listCoreDevicesRequest - default ListCoreDevicesPublisher listCoreDevicesPaginator(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
This is a variant of
listCoreDevices(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesPublisher publisher = client.listCoreDevicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesPublisher publisher = client.listCoreDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListCoreDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListCoreDevicesRequest.builder()
listCoreDevicesRequest - A Consumer that will call methods on ListCoreDevicesRequest.Builder to create a request.default CompletableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Retrieves a paginated list of deployments.
listDeploymentsRequest - default CompletableFuture<ListDeploymentsResponse> listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
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 via ListDeploymentsRequest.builder()
listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.default ListDeploymentsPublisher listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)
Retrieves a paginated list of deployments.
This is a variant of
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listDeploymentsRequest - default ListDeploymentsPublisher listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
Retrieves a paginated list of deployments.
This is a variant of
listDeployments(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListDeploymentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDeploymentsRequest.builder()
listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.default CompletableFuture<ListEffectiveDeploymentsResponse> listEffectiveDeployments(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
listEffectiveDeploymentsRequest - default CompletableFuture<ListEffectiveDeploymentsResponse> listEffectiveDeployments(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest)
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 via ListEffectiveDeploymentsRequest.builder()
listEffectiveDeploymentsRequest - A Consumer that will call methods on ListEffectiveDeploymentsRequest.Builder to create a
request.default ListEffectiveDeploymentsPublisher listEffectiveDeploymentsPaginator(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
This is a variant of
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsPublisher publisher = client.listEffectiveDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsPublisher publisher = client.listEffectiveDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listEffectiveDeploymentsRequest - default ListEffectiveDeploymentsPublisher listEffectiveDeploymentsPaginator(Consumer<ListEffectiveDeploymentsRequest.Builder> listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
This is a variant of
listEffectiveDeployments(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsPublisher publisher = client.listEffectiveDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsPublisher publisher = client.listEffectiveDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListEffectiveDeploymentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListEffectiveDeploymentsRequest.builder()
listEffectiveDeploymentsRequest - A Consumer that will call methods on ListEffectiveDeploymentsRequest.Builder to create a
request.default CompletableFuture<ListInstalledComponentsResponse> listInstalledComponents(ListInstalledComponentsRequest listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
listInstalledComponentsRequest - default CompletableFuture<ListInstalledComponentsResponse> listInstalledComponents(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
This is a convenience which creates an instance of the ListInstalledComponentsRequest.Builder avoiding
the need to create one manually via ListInstalledComponentsRequest.builder()
listInstalledComponentsRequest - A Consumer that will call methods on ListInstalledComponentsRequest.Builder to create a
request.default ListInstalledComponentsPublisher listInstalledComponentsPaginator(ListInstalledComponentsRequest listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
This is a variant of
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsPublisher publisher = client.listInstalledComponentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsPublisher publisher = client.listInstalledComponentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listInstalledComponentsRequest - default ListInstalledComponentsPublisher listInstalledComponentsPaginator(Consumer<ListInstalledComponentsRequest.Builder> listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
This is a variant of
listInstalledComponents(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsPublisher publisher = client.listInstalledComponentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsPublisher publisher = client.listInstalledComponentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.greengrassv2.model.ListInstalledComponentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListInstalledComponentsRequest.builder()
listInstalledComponentsRequest - A Consumer that will call methods on ListInstalledComponentsRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an IoT Greengrass resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ResolveComponentCandidatesResponse> resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest)
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 component B 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.
resolveComponentCandidatesRequest - default CompletableFuture<ResolveComponentCandidatesResponse> resolveComponentCandidates(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest)
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 component B 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 via ResolveComponentCandidatesRequest.builder()
resolveComponentCandidatesRequest - A Consumer that will call methods on ResolveComponentCandidatesRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an IoT Greengrass resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.Copyright © 2021. All rights reserved.