@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GreengrassV2Client 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 BatchAssociateClientDeviceWithCoreDeviceResponse |
batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest)
Associate a list of client devices with a core device.
|
default BatchAssociateClientDeviceWithCoreDeviceResponse |
batchAssociateClientDeviceWithCoreDevice(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest)
Associate a list of client devices with a core device.
|
default BatchDisassociateClientDeviceFromCoreDeviceResponse |
batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate a list of client devices from a core device.
|
default BatchDisassociateClientDeviceFromCoreDeviceResponse |
batchDisassociateClientDeviceFromCoreDevice(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest)
Disassociate a list of client devices from a core device.
|
static GreengrassV2ClientBuilder |
builder()
Create a builder that can be used to configure and create a
GreengrassV2Client. |
default CancelDeploymentResponse |
cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest)
Cancels a deployment.
|
default CancelDeploymentResponse |
cancelDeployment(Consumer<CancelDeploymentRequest.Builder> cancelDeploymentRequest)
Cancels a deployment.
|
static GreengrassV2Client |
create()
Create a
GreengrassV2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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 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.
|
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.
|
default GetComponentVersionArtifactResponse |
getComponentVersionArtifact(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public component artifact.
|
default GetComponentVersionArtifactResponse |
getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest)
Gets the pre-signed URL to download a public component artifact.
|
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 ListClientDevicesAssociatedWithCoreDeviceResponse |
listClientDevicesAssociatedWithCoreDevice(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default ListClientDevicesAssociatedWithCoreDeviceResponse |
listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default ListClientDevicesAssociatedWithCoreDeviceIterable |
listClientDevicesAssociatedWithCoreDevicePaginator(Consumer<ListClientDevicesAssociatedWithCoreDeviceRequest.Builder> listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
default ListClientDevicesAssociatedWithCoreDeviceIterable |
listClientDevicesAssociatedWithCoreDevicePaginator(ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest)
Retrieves a paginated list of client devices that are associated with a core device.
|
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)
Retrieves a paginated list of component summaries.
|
default ListComponentsIterable |
listComponentsPaginator(ListComponentsRequest listComponentsRequest)
Retrieves a paginated list of component summaries.
|
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)
Retrieves a paginated list of all versions for a component.
|
default ListComponentVersionsIterable |
listComponentVersionsPaginator(ListComponentVersionsRequest listComponentVersionsRequest)
Retrieves a paginated list of all versions for a component.
|
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)
Retrieves a paginated list of Greengrass core devices.
|
default ListCoreDevicesIterable |
listCoreDevicesPaginator(ListCoreDevicesRequest listCoreDevicesRequest)
Retrieves a paginated list of Greengrass core devices.
|
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)
Retrieves a paginated list of deployments.
|
default ListDeploymentsIterable |
listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)
Retrieves a paginated list of deployments.
|
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)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
default ListEffectiveDeploymentsIterable |
listEffectiveDeploymentsPaginator(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
|
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)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
default ListInstalledComponentsIterable |
listInstalledComponentsPaginator(ListInstalledComponentsRequest listInstalledComponentsRequest)
Retrieves a paginated list of the components that a Greengrass core device runs.
|
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.
|
default ResolveComponentCandidatesResponse |
resolveComponentCandidates(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest)
Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
|
default ResolveComponentCandidatesResponse |
resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest)
Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
|
static ServiceMetadata |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static GreengrassV2Client create()
GreengrassV2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GreengrassV2ClientBuilder builder()
GreengrassV2Client.default BatchAssociateClientDeviceWithCoreDeviceResponse batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchAssociateClientDeviceWithCoreDeviceResponse batchAssociateClientDeviceWithCoreDevice(Consumer<BatchAssociateClientDeviceWithCoreDeviceRequest.Builder> batchAssociateClientDeviceWithCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateClientDeviceFromCoreDeviceResponse batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateClientDeviceFromCoreDeviceResponse batchDisassociateClientDeviceFromCoreDevice(Consumer<BatchDisassociateClientDeviceFromCoreDeviceRequest.Builder> batchDisassociateClientDeviceFromCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
cancelDeploymentRequest - ResourceNotFoundException - The requested resource can't be found.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CancelDeploymentRequest.builder()
cancelDeploymentRequest - A Consumer that will call methods on CancelDeploymentRequest.Builder to create a request.ResourceNotFoundException - The requested resource can't be found.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ServiceQuotaExceededException - Your request exceeds a service quota. For example, you might have the maximum number of components that
you can create.AccessDeniedException - You don't have permission to perform the action.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.RequestAlreadyInProgressException - The request is already in progress. This exception occurs when you use a client token for multiple
requests while IoT Greengrass is still processing an earlier request that uses the same client token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ServiceQuotaExceededException - Your request exceeds a service quota. For example, you might have the maximum number of components that
you can create.AccessDeniedException - You don't have permission to perform the action.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.RequestAlreadyInProgressException - The request is already in progress. This exception occurs when you use a client token for multiple
requests while IoT Greengrass is still processing an earlier request that uses the same client token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, 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. 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 - ResourceNotFoundException - The requested resource can't be found.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.RequestAlreadyInProgressException - The request is already in progress. This exception occurs when you use a client token for multiple
requests while IoT Greengrass is still processing an earlier request that uses the same client token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, 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. 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.ResourceNotFoundException - The requested resource can't be found.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.RequestAlreadyInProgressException - The request is already in progress. This exception occurs when you use a client token for multiple
requests while IoT Greengrass is still processing an earlier request that uses the same client token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteComponentRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteComponentRequest.builder()
deleteComponentRequest - A Consumer that will call methods on DeleteComponentRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteCoreDeviceRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteCoreDeviceRequest.builder()
deleteCoreDeviceRequest - A Consumer that will call methods on DeleteCoreDeviceRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeComponentResponse describeComponent(DescribeComponentRequest describeComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves metadata for a version of a component.
describeComponentRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeComponentRequest.builder()
describeComponentRequest - A Consumer that will call methods on DescribeComponentRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetComponentVersionArtifactResponse getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetComponentVersionArtifactResponse getComponentVersionArtifact(Consumer<GetComponentVersionArtifactRequest.Builder> getComponentVersionArtifactRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCoreDeviceResponse getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves metadata for a Greengrass core device.
getCoreDeviceRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCoreDeviceResponse getCoreDevice(Consumer<GetCoreDeviceRequest.Builder> getCoreDeviceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getDeploymentRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetDeploymentRequest.builder()
getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listClientDevicesAssociatedWithCoreDeviceRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via
ListClientDevicesAssociatedWithCoreDeviceRequest.builder()
listClientDevicesAssociatedWithCoreDeviceRequest - A Consumer that will call methods on
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListClientDevicesAssociatedWithCoreDeviceIterable listClientDevicesAssociatedWithCoreDevicePaginator(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.
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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listClientDevicesAssociatedWithCoreDeviceRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListClientDevicesAssociatedWithCoreDeviceIterable listClientDevicesAssociatedWithCoreDevicePaginator(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 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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListClientDevicesAssociatedWithCoreDeviceIterable responses = client.listClientDevicesAssociatedWithCoreDevicePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via
ListClientDevicesAssociatedWithCoreDeviceRequest.builder()
listClientDevicesAssociatedWithCoreDeviceRequest - A Consumer that will call methods on
ListClientDevicesAssociatedWithCoreDeviceRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listComponentVersionsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListComponentVersionsRequest.builder()
listComponentVersionsRequest - A Consumer that will call methods on ListComponentVersionsRequest.Builder to create a
request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentVersionsIterable listComponentVersionsPaginator(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.
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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listComponentVersionsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentVersionsIterable listComponentVersionsPaginator(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 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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentVersionsIterable responses = client.listComponentVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListComponentVersionsRequest.builder()
listComponentVersionsRequest - A Consumer that will call methods on ListComponentVersionsRequest.Builder to create a
request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
listComponentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, 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 via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, 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 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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listComponentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, 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 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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCoreDevicesResponse listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves a paginated list of Greengrass core devices.
listCoreDevicesRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCoreDevicesResponse listCoreDevices(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCoreDevicesIterable listCoreDevicesPaginator(ListCoreDevicesRequest listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listCoreDevicesRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCoreDevicesIterable listCoreDevicesPaginator(Consumer<ListCoreDevicesRequest.Builder> listCoreDevicesRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListCoreDevicesIterable responses = client.listCoreDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListCoreDevicesRequest.builder()
listCoreDevicesRequest - A Consumer that will call methods on ListCoreDevicesRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves a paginated list of deployments.
listDeploymentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDeploymentsRequest.builder()
listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDeploymentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListDeploymentsRequest.builder()
listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listEffectiveDeploymentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListEffectiveDeploymentsRequest.builder()
listEffectiveDeploymentsRequest - A Consumer that will call methods on ListEffectiveDeploymentsRequest.Builder to create a
request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEffectiveDeploymentsIterable listEffectiveDeploymentsPaginator(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.
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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listEffectiveDeploymentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEffectiveDeploymentsIterable listEffectiveDeploymentsPaginator(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 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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListEffectiveDeploymentsIterable responses = client.listEffectiveDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListEffectiveDeploymentsRequest.builder()
listEffectiveDeploymentsRequest - A Consumer that will call methods on ListEffectiveDeploymentsRequest.Builder to create a
request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listInstalledComponentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstalledComponentsIterable listInstalledComponentsPaginator(ListInstalledComponentsRequest listInstalledComponentsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, GreengrassV2Exception
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listInstalledComponentsRequest - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstalledComponentsIterable listInstalledComponentsPaginator(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.
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 Stream
software.amazon.awssdk.services.greengrassv2.paginators.ListInstalledComponentsIterable responses = client.listInstalledComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListInstalledComponentsRequest.builder()
listInstalledComponentsRequest - A Consumer that will call methods on ListInstalledComponentsRequest.Builder to create a
request.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.AccessDeniedException - You don't have permission to perform the action.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception
Retrieves the list of tags for an IoT Greengrass resource.
listTagsForResourceRequest - InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResolveComponentCandidatesResponse resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, 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 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 - ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResolveComponentCandidatesResponse resolveComponentCandidates(Consumer<ResolveComponentCandidatesRequest.Builder> resolveComponentCandidatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, 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 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.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.AccessDeniedException - You don't have permission to perform the action.ResourceNotFoundException - The requested resource can't be found.ThrottlingException - Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that
you can retrieve device or deployment status per second.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ConflictException - Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, GreengrassV2Exception
Removes a tag from an IoT Greengrass resource.
untagResourceRequest - InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InternalServerException - IoT Greengrass can't process your request right now. Try again later.ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters.ResourceNotFoundException - The requested resource can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GreengrassV2Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.