com.amazonaws.services.greengrassv2

Interface AWSGreengrassV2

All Known Subinterfaces:

AWSGreengrassV2Async

All Known Implementing Classes:

AbstractAWSGreengrassV2, AbstractAWSGreengrassV2Async, AWSGreengrassV2AsyncClient, AWSGreengrassV2Client

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSGreengrassV2

Interface for accessing AWS GreengrassV2.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSGreengrassV2 instead.

AWS 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 AWS IoT Core and export IoT data to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelDeploymentResult	cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest) Cancels a deployment.
CreateComponentVersionResult	createComponentVersion(CreateComponentVersionRequest createComponentVersionRequest) Creates a component.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest createDeploymentRequest) Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.
DeleteComponentResult	deleteComponent(DeleteComponentRequest deleteComponentRequest) Deletes a version of a component from AWS IoT Greengrass.
DeleteCoreDeviceResult	deleteCoreDevice(DeleteCoreDeviceRequest deleteCoreDeviceRequest) Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing.
DescribeComponentResult	describeComponent(DescribeComponentRequest describeComponentRequest) Retrieves metadata for a version of a component.
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 getComponentRequest) Gets the recipe for a version of a component.
GetComponentVersionArtifactResult	getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest) Gets the pre-signed URL to download a public component artifact.
GetCoreDeviceResult	getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest) Retrieves metadata for a AWS IoT Greengrass core device.
GetDeploymentResult	getDeployment(GetDeploymentRequest getDeploymentRequest) Gets a deployment.
ListComponentsResult	listComponents(ListComponentsRequest listComponentsRequest) Retrieves a paginated list of component summaries.
ListComponentVersionsResult	listComponentVersions(ListComponentVersionsRequest listComponentVersionsRequest) Retrieves a paginated list of all versions for a component.
ListCoreDevicesResult	listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest) Retrieves a paginated list of AWS IoT Greengrass core devices.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest listDeploymentsRequest) Retrieves a paginated list of deployments.
ListEffectiveDeploymentsResult	listEffectiveDeployments(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest) Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
ListInstalledComponentsResult	listInstalledComponents(ListInstalledComponentsRequest listInstalledComponentsRequest) Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags for an AWS IoT Greengrass resource.
ResolveComponentCandidatesResult	resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest) 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 tagResourceRequest) Adds tags to an AWS IoT Greengrass resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from an AWS IoT Greengrass resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelDeployment

CancelDeploymentResult cancelDeployment(CancelDeploymentRequest cancelDeploymentRequest)

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

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 - AWS 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

CreateComponentVersionResult createComponentVersion(CreateComponentVersionRequest createComponentVersionRequest)

Creates a component. Components are software that run on AWS IoT Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS 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 AWS IoT Greengrass component recipe reference in the AWS 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 AWS Lambda function that runs on AWS 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 AWS IoT Greengrass V1 to AWS 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.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

createDeployment

CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

Creates a continuous deployment for a target, which is a AWS IoT 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, AWS 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. AWS 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 AWS IoT Greengrass V2 Developer Guide.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

deleteComponent

DeleteComponentResult deleteComponent(DeleteComponentRequest deleteComponentRequest)

Deletes a version of a component from AWS IoT Greengrass.

This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.

Parameters:

deleteComponentRequest -

Returns:

Result of the DeleteComponent operation returned by the service.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

deleteCoreDevice

DeleteCoreDeviceResult deleteCoreDevice(DeleteCoreDeviceRequest deleteCoreDeviceRequest)

Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more information about how to delete the AWS IoT thing, see DeleteThing in the AWS IoT API Reference.

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 - AWS 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

describeComponent

DescribeComponentResult describeComponent(DescribeComponentRequest describeComponentRequest)

Retrieves metadata for a version of a component.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getComponent

GetComponentResult getComponent(GetComponentRequest getComponentRequest)

Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getComponentVersionArtifact

GetComponentVersionArtifactResult getComponentVersionArtifact(GetComponentVersionArtifactRequest getComponentVersionArtifactRequest)

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

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

getCoreDevice

GetCoreDeviceResult getCoreDevice(GetCoreDeviceRequest getCoreDeviceRequest)

Retrieves metadata for a AWS IoT Greengrass core device.

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 - AWS 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

GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)

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

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 - AWS 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

ListComponentVersionsResult listComponentVersions(ListComponentVersionsRequest listComponentVersionsRequest)

Retrieves a paginated list of all versions for a component.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

listComponents

ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest)

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

Parameters:

listComponentsRequest -

Returns:

Result of the ListComponents operation returned by the service.

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.

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 - AWS IoT Greengrass can't process your request right now. Try again later.

See Also:

AWS API Documentation

listCoreDevices

ListCoreDevicesResult listCoreDevices(ListCoreDevicesRequest listCoreDevicesRequest)

Retrieves a paginated list of AWS IoT Greengrass core devices.

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 - AWS 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

ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)

Retrieves a paginated list of deployments.

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 - AWS 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

ListEffectiveDeploymentsResult listEffectiveDeployments(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest)

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

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 - AWS 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

ListInstalledComponentsResult listInstalledComponents(ListInstalledComponentsRequest listInstalledComponentsRequest)

Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.

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 - AWS 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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Retrieves the list of tags for an AWS IoT Greengrass resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - AWS 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

ResolveComponentCandidatesResult resolveComponentCandidates(ResolveComponentCandidatesRequest resolveComponentCandidatesRequest)

Retrieves a list of components that meet the component, version, and platform requirements of a deployment. AWS IoT 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, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.

To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.

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.

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 - AWS 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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - AWS 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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from an AWS IoT Greengrass resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - AWS 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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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