@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSGreengrassV2 extends Object implements AWSGreengrassV2
AWSGreengrassV2. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
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 AWS IoT Greengrass core device or group of core devices.
|
DeleteComponentResult |
deleteComponent(DeleteComponentRequest request)
Deletes a version of a component from AWS IoT Greengrass.
|
DeleteCoreDeviceResult |
deleteCoreDevice(DeleteCoreDeviceRequest request)
Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing.
|
DescribeComponentResult |
describeComponent(DescribeComponentRequest request)
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 request)
Gets the recipe for a version of a component.
|
GetComponentVersionArtifactResult |
getComponentVersionArtifact(GetComponentVersionArtifactRequest request)
Gets the pre-signed URL to a component artifact in an S3 bucket.
|
GetCoreDeviceResult |
getCoreDevice(GetCoreDeviceRequest request)
Retrieves metadata for a AWS IoT Greengrass core device.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest request)
Gets a deployment.
|
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 AWS IoT 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 AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
|
ListInstalledComponentsResult |
listInstalledComponents(ListInstalledComponentsRequest request)
Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for an AWS 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 AWS IoT Greengrass resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an AWS IoT Greengrass resource.
|
public CancelDeploymentResult cancelDeployment(CancelDeploymentRequest request)
AWSGreengrassV2Cancels 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.
cancelDeployment in interface AWSGreengrassV2public CreateComponentVersionResult createComponentVersion(CreateComponentVersionRequest request)
AWSGreengrassV2Creates 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.
createComponentVersion in interface AWSGreengrassV2public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AWSGreengrassV2Creates 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.
createDeployment in interface AWSGreengrassV2public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
AWSGreengrassV2Deletes 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.
deleteComponent in interface AWSGreengrassV2public DeleteCoreDeviceResult deleteCoreDevice(DeleteCoreDeviceRequest request)
AWSGreengrassV2Deletes 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.
deleteCoreDevice in interface AWSGreengrassV2public DescribeComponentResult describeComponent(DescribeComponentRequest request)
AWSGreengrassV2Retrieves metadata for a version of a component.
describeComponent in interface AWSGreengrassV2public GetComponentResult getComponent(GetComponentRequest request)
AWSGreengrassV2Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.
getComponent in interface AWSGreengrassV2public GetComponentVersionArtifactResult getComponentVersionArtifact(GetComponentVersionArtifactRequest request)
AWSGreengrassV2Gets the pre-signed URL to a component artifact in an S3 bucket. Core devices can call this operation to identify the URL that they can use to download an artifact to install.
getComponentVersionArtifact in interface AWSGreengrassV2public GetCoreDeviceResult getCoreDevice(GetCoreDeviceRequest request)
AWSGreengrassV2Retrieves metadata for a AWS IoT Greengrass core device.
getCoreDevice in interface AWSGreengrassV2public GetDeploymentResult getDeployment(GetDeploymentRequest request)
AWSGreengrassV2Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.
getDeployment in interface AWSGreengrassV2public ListComponentVersionsResult listComponentVersions(ListComponentVersionsRequest request)
AWSGreengrassV2Retrieves a paginated list of all versions for a component.
listComponentVersions in interface AWSGreengrassV2public ListComponentsResult listComponents(ListComponentsRequest request)
AWSGreengrassV2Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
listComponents in interface AWSGreengrassV2public ListCoreDevicesResult listCoreDevices(ListCoreDevicesRequest request)
AWSGreengrassV2Retrieves a paginated list of AWS IoT Greengrass core devices.
listCoreDevices in interface AWSGreengrassV2public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
AWSGreengrassV2Retrieves a paginated list of deployments.
listDeployments in interface AWSGreengrassV2public ListEffectiveDeploymentsResult listEffectiveDeployments(ListEffectiveDeploymentsRequest request)
AWSGreengrassV2Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
listEffectiveDeployments in interface AWSGreengrassV2public ListInstalledComponentsResult listInstalledComponents(ListInstalledComponentsRequest request)
AWSGreengrassV2Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
listInstalledComponents in interface AWSGreengrassV2public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSGreengrassV2Retrieves the list of tags for an AWS IoT Greengrass resource.
listTagsForResource in interface AWSGreengrassV2public ResolveComponentCandidatesResult resolveComponentCandidates(ResolveComponentCandidatesRequest request)
AWSGreengrassV2Retrieves 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.
resolveComponentCandidates in interface AWSGreengrassV2public TagResourceResult tagResource(TagResourceRequest request)
AWSGreengrassV2Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResource in interface AWSGreengrassV2public UntagResourceResult untagResource(UntagResourceRequest request)
AWSGreengrassV2Removes a tag from an AWS IoT Greengrass resource.
untagResource in interface AWSGreengrassV2public void shutdown()
AWSGreengrassV2shutdown in interface AWSGreengrassV2public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSGreengrassV2Response 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.
getCachedResponseMetadata in interface AWSGreengrassV2request - The originally executed request.