AbstractAWSGreengrassV2 (AWS Java SDK for AWS IoT Greengrass V2 1.12.62 API)

java.lang.Object
- com.amazonaws.services.greengrassv2.AbstractAWSGreengrassV2

All Implemented Interfaces:

AWSGreengrassV2

Direct Known Subclasses:

AbstractAWSGreengrassV2Async
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSGreengrassV2
extends Object
implements AWSGreengrassV2
```
Abstract implementation of AWSGreengrassV2. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.greengrassv2.AWSGreengrassV2
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSGreengrassV2()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSGreengrassV2()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchAssociateClientDeviceWithCoreDeviceResult`	`batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest request)` Associate a list of client devices with a core device.
`BatchDisassociateClientDeviceFromCoreDeviceResult`	`batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest request)` Disassociate a list of client devices from a core device.
`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.
`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 download a public component artifact.
`GetCoreDeviceResult`	`getCoreDevice(GetCoreDeviceRequest request)` Retrieves metadata for a Greengrass core device.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest request)` Gets a deployment.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSGreengrassV2
```
protected AbstractAWSGreengrassV2()
```
- Method Detail
  - batchAssociateClientDeviceWithCoreDevice
```
public BatchAssociateClientDeviceWithCoreDeviceResult batchAssociateClientDeviceWithCoreDevice(BatchAssociateClientDeviceWithCoreDeviceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    batchAssociateClientDeviceWithCoreDevice in interface AWSGreengrassV2
    
    Returns:
    
    Result of the BatchAssociateClientDeviceWithCoreDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateClientDeviceFromCoreDevice
```
public BatchDisassociateClientDeviceFromCoreDeviceResult batchDisassociateClientDeviceFromCoreDevice(BatchDisassociateClientDeviceFromCoreDeviceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    batchDisassociateClientDeviceFromCoreDevice in interface AWSGreengrassV2
    
    Returns:
    
    Result of the BatchDisassociateClientDeviceFromCoreDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelDeployment
```
public CancelDeploymentResult cancelDeployment(CancelDeploymentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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
    
    Returns:
    
    Result of the CancelDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createComponentVersion
```
public CreateComponentVersionResult createComponentVersion(CreateComponentVersionRequest request)
```
    Description copied from interface: AWSGreengrassV2
    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.
    Specified by:
    
    createComponentVersion in interface AWSGreengrassV2
    
    Returns:
    
    Result of the CreateComponentVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDeployment
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    createDeployment in interface AWSGreengrassV2
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteComponent
```
public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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
    
    Returns:
    
    Result of the DeleteComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCoreDevice
```
public DeleteCoreDeviceResult deleteCoreDevice(DeleteCoreDeviceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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
    
    Returns:
    
    Result of the DeleteCoreDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeComponent
```
public DescribeComponentResult describeComponent(DescribeComponentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves metadata for a version of a component.
    
    Specified by:
    
    describeComponent in interface AWSGreengrassV2
    
    Returns:
    
    Result of the DescribeComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getComponent
```
public GetComponentResult getComponent(GetComponentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    getComponent in interface AWSGreengrassV2
    
    Returns:
    
    Result of the GetComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getComponentVersionArtifact
```
public GetComponentVersionArtifactResult getComponentVersionArtifact(GetComponentVersionArtifactRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    getComponentVersionArtifact in interface AWSGreengrassV2
    
    Returns:
    
    Result of the GetComponentVersionArtifact operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCoreDevice
```
public GetCoreDeviceResult getCoreDevice(GetCoreDeviceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves metadata for a Greengrass core device.
    
    Specified by:
    
    getCoreDevice in interface AWSGreengrassV2
    
    Returns:
    
    Result of the GetCoreDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeployment
```
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Gets a deployment. Deployments define the components that run on Greengrass core devices.
    
    Specified by:
    
    getDeployment in interface AWSGreengrassV2
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClientDevicesAssociatedWithCoreDevice
```
public ListClientDevicesAssociatedWithCoreDeviceResult listClientDevicesAssociatedWithCoreDevice(ListClientDevicesAssociatedWithCoreDeviceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of client devices that are associated with a core device.
    
    Specified by:
    
    listClientDevicesAssociatedWithCoreDevice in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListClientDevicesAssociatedWithCoreDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listComponentVersions
```
public ListComponentVersionsResult listComponentVersions(ListComponentVersionsRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of all versions for a component. Greater versions are listed first.
    
    Specified by:
    
    listComponentVersions in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListComponentVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listComponents
```
public ListComponentsResult listComponents(ListComponentsRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
    
    Specified by:
    
    listComponents in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListComponents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCoreDevices
```
public ListCoreDevicesResult listCoreDevices(ListCoreDevicesRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of Greengrass core devices.
    
    Specified by:
    
    listCoreDevices in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListCoreDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of deployments.
    
    Specified by:
    
    listDeployments in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListDeployments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEffectiveDeployments
```
public ListEffectiveDeploymentsResult listEffectiveDeployments(ListEffectiveDeploymentsRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
    
    Specified by:
    
    listEffectiveDeployments in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListEffectiveDeployments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listInstalledComponents
```
public ListInstalledComponentsResult listInstalledComponents(ListInstalledComponentsRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves a paginated list of the components that a Greengrass core device runs.
    
    Specified by:
    
    listInstalledComponents in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListInstalledComponents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Retrieves the list of tags for an IoT Greengrass resource.
    
    Specified by:
    
    listTagsForResource in interface AWSGreengrassV2
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resolveComponentCandidates
```
public ResolveComponentCandidatesResult resolveComponentCandidates(ResolveComponentCandidatesRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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
    
    Returns:
    
    Result of the ResolveComponentCandidates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    Removes a tag from an IoT Greengrass resource.
    
    Specified by:
    
    untagResource in interface AWSGreengrassV2
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    Specified by:
    
    shutdown in interface AWSGreengrassV2
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSGreengrassV2
    
    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.
    
    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.

Class AbstractAWSGreengrassV2

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSGreengrassV2

Method Detail

batchAssociateClientDeviceWithCoreDevice

batchDisassociateClientDeviceFromCoreDevice

cancelDeployment

createComponentVersion

createDeployment

deleteComponent

deleteCoreDevice

describeComponent

getComponent

getComponentVersionArtifact

getCoreDevice

getDeployment

listClientDevicesAssociatedWithCoreDevice

listComponentVersions

listComponents

listCoreDevices

listDeployments

listEffectiveDeployments

listInstalledComponents

listTagsForResource

resolveComponentCandidates

tagResource

untagResource

shutdown

getCachedResponseMetadata