com.amazonaws.services.greengrassv2

Class AWSGreengrassV2Client

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.greengrassv2.AWSGreengrassV2Client

All Implemented Interfaces:

AWSGreengrassV2

Direct Known Subclasses:

AWSGreengrassV2AsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSGreengrassV2Client
extends AmazonWebServiceClient
implements AWSGreengrassV2

Client for accessing AWS GreengrassV2. All service calls made using this client are blocking, and will not return until the service call completes.

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.greengrassv2.AWSGreengrassV2

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateServiceRoleToAccountResult	associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest request) Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
BatchAssociateClientDeviceWithCoreDeviceResult	batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest request) Associates a list of client devices with a core device.
BatchDisassociateClientDeviceFromCoreDeviceResult	batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest request) Disassociates a list of client devices from a core device.
static AWSGreengrassV2ClientBuilder	builder()
CancelDeploymentResult	cancelDeployment(CancelDeploymentRequest request) Cancels a deployment.
CreateComponentVersionResult	createComponentVersion(CreateComponentVersionRequest request) Creates a component.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest request) Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.
DeleteComponentResult	deleteComponent(DeleteComponentRequest request) Deletes a version of a component from IoT Greengrass.
DeleteCoreDeviceResult	deleteCoreDevice(DeleteCoreDeviceRequest request) Deletes a Greengrass core device, which is an IoT thing.
DeleteDeploymentResult	deleteDeployment(DeleteDeploymentRequest request) Deletes a deployment.
DescribeComponentResult	describeComponent(DescribeComponentRequest request) Retrieves metadata for a version of a component.
DisassociateServiceRoleFromAccountResult	disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest request) Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetComponentResult	getComponent(GetComponentRequest request) Gets the recipe for a version of a component.
GetComponentVersionArtifactResult	getComponentVersionArtifact(GetComponentVersionArtifactRequest request) Gets the pre-signed URL to download a public or a Lambda component artifact.
GetConnectivityInfoResult	getConnectivityInfo(GetConnectivityInfoRequest request) Retrieves connectivity information for a Greengrass core device.
GetCoreDeviceResult	getCoreDevice(GetCoreDeviceRequest request) Retrieves metadata for a Greengrass core device.
GetDeploymentResult	getDeployment(GetDeploymentRequest request) Gets a deployment.
GetServiceRoleForAccountResult	getServiceRoleForAccount(GetServiceRoleForAccountRequest request) Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
ListClientDevicesAssociatedWithCoreDeviceResult	listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest request) Retrieves a paginated list of client devices that are associated with a core device.
ListComponentsResult	listComponents(ListComponentsRequest request) Retrieves a paginated list of component summaries.
ListComponentVersionsResult	listComponentVersions(ListComponentVersionsRequest request) Retrieves a paginated list of all versions for a component.
ListCoreDevicesResult	listCoreDevices(ListCoreDevicesRequest request) Retrieves a paginated list of Greengrass core devices.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest request) Retrieves a paginated list of deployments.
ListEffectiveDeploymentsResult	listEffectiveDeployments(ListEffectiveDeploymentsRequest request) Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
ListInstalledComponentsResult	listInstalledComponents(ListInstalledComponentsRequest request) Retrieves a paginated list of the components that a Greengrass core device runs.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Retrieves the list of tags for an IoT Greengrass resource.
ResolveComponentCandidatesResult	resolveComponentCandidates(ResolveComponentCandidatesRequest request) Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds tags to an IoT Greengrass resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from an IoT Greengrass resource.
UpdateConnectivityInfoResult	updateConnectivityInfo(UpdateConnectivityInfoRequest request) Updates connectivity information for a Greengrass core device.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSGreengrassV2ClientBuilder builder()

associateServiceRoleToAccount

public AssociateServiceRoleToAccountResult associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest request)

Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Specified by:

associateServiceRoleToAccount in interface AWSGreengrassV2

Parameters:

associateServiceRoleToAccountRequest -

Returns:

Result of the AssociateServiceRoleToAccount operation returned by the service.

Throws:

ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException - IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

batchAssociateClientDeviceWithCoreDevice

public BatchAssociateClientDeviceWithCoreDeviceResult batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest request)

Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.

Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.

Specified by:

batchAssociateClientDeviceWithCoreDevice in interface AWSGreengrassV2

Parameters:

batchAssociateClientDeviceWithCoreDeviceRequest -

Returns:

Result of the BatchAssociateClientDeviceWithCoreDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchDisassociateClientDeviceFromCoreDevice

public BatchDisassociateClientDeviceFromCoreDeviceResult batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest request)

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.

Specified by:

batchDisassociateClientDeviceFromCoreDevice in interface AWSGreengrassV2

Parameters:

batchDisassociateClientDeviceFromCoreDeviceRequest -

Returns:

Result of the BatchDisassociateClientDeviceFromCoreDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

cancelDeployment

public CancelDeploymentResult cancelDeployment(CancelDeploymentRequest request)

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.

Specified by:

cancelDeployment in interface AWSGreengrassV2

Parameters:

cancelDeploymentRequest -

Returns:

Result of the CancelDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createComponentVersion

public CreateComponentVersionResult createComponentVersion(CreateComponentVersionRequest request)

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:

• Create components from recipes

  Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide.

  To create a component from a recipe, specify inlineRecipe when you call this operation.

• Create components from Lambda functions

  Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.

  This function only accepts Lambda functions that use the following runtimes:

  • Python 2.7 – python2.7

  • Python 3.7 – python3.7

  • Python 3.8 – python3.8

  • Python 3.9 – python3.9

  • Java 8 – java8

  • Java 11 – java11

  • Node.js 10 – nodejs10.x

  • Node.js 12 – nodejs12.x

  • Node.js 14 – nodejs14.x

  To create a component from a Lambda function, specify lambdaFunction when you call this operation.

  IoT Greengrass currently supports Lambda functions on only Linux core devices.

Specified by:

createComponentVersion in interface AWSGreengrassV2

Parameters:

createComponentVersionRequest -

Returns:

Result of the CreateComponentVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDeployment

public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)

Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.

For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.

Specified by:

createDeployment in interface AWSGreengrassV2

Parameters:

createDeploymentRequest -

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

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.

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.

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.

See Also:

AWS API Documentation

deleteComponent

public DeleteComponentResult deleteComponent(DeleteComponentRequest request)

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.

Specified by:

deleteComponent in interface AWSGreengrassV2

Parameters:

deleteComponentRequest -

Returns:

Result of the DeleteComponent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteCoreDevice

public DeleteCoreDeviceResult deleteCoreDevice(DeleteCoreDeviceRequest request)

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.

Specified by:

deleteCoreDevice in interface AWSGreengrassV2

Parameters:

deleteCoreDeviceRequest -

Returns:

Result of the DeleteCoreDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDeployment

public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)

Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.

Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.

Specified by:

deleteDeployment in interface AWSGreengrassV2

Parameters:

deleteDeploymentRequest -

Returns:

Result of the DeleteDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeComponent

public DescribeComponentResult describeComponent(DescribeComponentRequest request)

Retrieves metadata for a version of a component.

Specified by:

describeComponent in interface AWSGreengrassV2

Parameters:

describeComponentRequest -

Returns:

Result of the DescribeComponent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateServiceRoleFromAccount

public DisassociateServiceRoleFromAccountResult disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest request)

Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Specified by:

disassociateServiceRoleFromAccount in interface AWSGreengrassV2

Parameters:

disassociateServiceRoleFromAccountRequest -

Returns:

Result of the DisassociateServiceRoleFromAccount operation returned by the service.

Throws:

InternalServerException - IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getComponent

public GetComponentResult getComponent(GetComponentRequest request)

Gets the recipe for a version of a component.

Specified by:

getComponent in interface AWSGreengrassV2

Parameters:

getComponentRequest -

Returns:

Result of the GetComponent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getComponentVersionArtifact

public GetComponentVersionArtifactResult getComponentVersionArtifact(GetComponentVersionArtifactRequest request)

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

Specified by:

getComponentVersionArtifact in interface AWSGreengrassV2

Parameters:

getComponentVersionArtifactRequest -

Returns:

Result of the GetComponentVersionArtifact operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getConnectivityInfo

public GetConnectivityInfoResult getConnectivityInfo(GetConnectivityInfoRequest request)

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

Specified by:

getConnectivityInfo in interface AWSGreengrassV2

Parameters:

getConnectivityInfoRequest -

Returns:

Result of the GetConnectivityInfo operation returned by the service.

Throws:

ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException - IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getCoreDevice

public GetCoreDeviceResult getCoreDevice(GetCoreDeviceRequest request)

Retrieves metadata for a Greengrass core device.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

• When the IoT Greengrass Core software starts

• When the core device receives a deployment from the Amazon Web Services Cloud

• When the status of any component on the core device becomes BROKEN

• At a regular interval that you can configure, which defaults to 24 hours

• For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Specified by:

getCoreDevice in interface AWSGreengrassV2

Parameters:

getCoreDeviceRequest -

Returns:

Result of the GetCoreDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDeployment

public GetDeploymentResult getDeployment(GetDeploymentRequest request)

Gets a deployment. Deployments define the components that run on Greengrass core devices.

Specified by:

getDeployment in interface AWSGreengrassV2

Parameters:

getDeploymentRequest -

Returns:

Result of the GetDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getServiceRoleForAccount

public GetServiceRoleForAccountResult getServiceRoleForAccount(GetServiceRoleForAccountRequest request)

Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Specified by:

getServiceRoleForAccount in interface AWSGreengrassV2

Parameters:

getServiceRoleForAccountRequest -

Returns:

Result of the GetServiceRoleForAccount operation returned by the service.

Throws:

InternalServerException - IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

listClientDevicesAssociatedWithCoreDevice

public ListClientDevicesAssociatedWithCoreDeviceResult listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest request)

Retrieves a paginated list of client devices that are associated with a core device.

Specified by:

listClientDevicesAssociatedWithCoreDevice in interface AWSGreengrassV2

Parameters:

listClientDevicesAssociatedWithCoreDeviceRequest -

Returns:

Result of the ListClientDevicesAssociatedWithCoreDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listComponentVersions

public ListComponentVersionsResult listComponentVersions(ListComponentVersionsRequest request)

Retrieves a paginated list of all versions for a component. Greater versions are listed first.

Specified by:

listComponentVersions in interface AWSGreengrassV2

Parameters:

listComponentVersionsRequest -

Returns:

Result of the ListComponentVersions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listComponents

public ListComponentsResult listComponents(ListComponentsRequest request)

Retrieves a paginated list of component summaries. This list includes components that you have permission to view.

Specified by:

listComponents in interface AWSGreengrassV2

Parameters:

listComponentsRequest -

Returns:

Result of the ListComponents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listCoreDevices

public ListCoreDevicesResult listCoreDevices(ListCoreDevicesRequest request)

Retrieves a paginated list of Greengrass core devices.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

• When the IoT Greengrass Core software starts

• When the core device receives a deployment from the Amazon Web Services Cloud

• When the status of any component on the core device becomes BROKEN

• At a regular interval that you can configure, which defaults to 24 hours

• For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Specified by:

listCoreDevices in interface AWSGreengrassV2

Parameters:

listCoreDevicesRequest -

Returns:

Result of the ListCoreDevices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDeployments

public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)

Retrieves a paginated list of deployments.

Specified by:

listDeployments in interface AWSGreengrassV2

Parameters:

listDeploymentsRequest -

Returns:

Result of the ListDeployments operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEffectiveDeployments

public ListEffectiveDeploymentsResult listEffectiveDeployments(ListEffectiveDeploymentsRequest request)

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

Specified by:

listEffectiveDeployments in interface AWSGreengrassV2

Parameters:

listEffectiveDeploymentsRequest -

Returns:

Result of the ListEffectiveDeployments operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listInstalledComponents

public ListInstalledComponentsResult listInstalledComponents(ListInstalledComponentsRequest request)

Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

• When the IoT Greengrass Core software starts

• When the core device receives a deployment from the Amazon Web Services Cloud

• When the status of any component on the core device becomes BROKEN

• At a regular interval that you can configure, which defaults to 24 hours

• For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Specified by:

listInstalledComponents in interface AWSGreengrassV2

Parameters:

listInstalledComponentsRequest -

Returns:

Result of the ListInstalledComponents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Retrieves the list of tags for an IoT Greengrass resource.

Specified by:

listTagsForResource in interface AWSGreengrassV2

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

resolveComponentCandidates

public ResolveComponentCandidatesResult resolveComponentCandidates(ResolveComponentCandidatesRequest request)

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.

Specified by:

resolveComponentCandidates in interface AWSGreengrassV2

Parameters:

resolveComponentCandidatesRequest -

Returns:

Result of the ResolveComponentCandidates operation returned by the service.

Throws:

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.

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.

Specified by:

tagResource in interface AWSGreengrassV2

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from an IoT Greengrass resource.

Specified by:

untagResource in interface AWSGreengrassV2

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateConnectivityInfo

public UpdateConnectivityInfoResult updateConnectivityInfo(UpdateConnectivityInfoRequest request)

Updates connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

Specified by:

updateConnectivityInfo in interface AWSGreengrassV2

Parameters:

updateConnectivityInfoRequest -

Returns:

Result of the UpdateConnectivityInfo operation returned by the service.

Throws:

ValidationException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException - IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSGreengrassV2

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSGreengrassV2

Overrides:

shutdown in class AmazonWebServiceClient