GreengrassClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable
```
@Generated("software.amazon.awssdk:codegen")
public interface GreengrassClient
extends AutoCloseable
```
Service client for accessing null. This can be created using the static builder() method. AWS Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.

Field Summary

Fields
Modifier and Type Field Description

static String SERVICE_NAME

Fields
Modifier and Type	Field	Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default AssociateRoleToGroupResponse`	`associateRoleToGroup(AssociateRoleToGroupRequest associateRoleToGroupRequest)`	Associates a role with a group.
`default AssociateServiceRoleToAccountResponse`	`associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest)`	Associates a role which is used by AWS Greengrass.
`static GreengrassClientBuilder`	`builder()`	Create a builder that can be used to configure and create a `GreengrassClient`.
`static GreengrassClient`	`create()`	Create a `GreengrassClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CreateCoreDefinitionResponse`	`createCoreDefinition(CreateCoreDefinitionRequest createCoreDefinitionRequest)`	Creates a core definition.
`default CreateCoreDefinitionVersionResponse`	`createCoreDefinitionVersion(CreateCoreDefinitionVersionRequest createCoreDefinitionVersionRequest)`	Creates a version of a core definition that has already been defined.
`default CreateDeploymentResponse`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)`	Creates a deployment.
`default CreateDeviceDefinitionResponse`	`createDeviceDefinition(CreateDeviceDefinitionRequest createDeviceDefinitionRequest)`	Creates a device definition.
`default CreateDeviceDefinitionVersionResponse`	`createDeviceDefinitionVersion(CreateDeviceDefinitionVersionRequest createDeviceDefinitionVersionRequest)`	Creates a version of a device definition that has already been defined.
`default CreateFunctionDefinitionResponse`	`createFunctionDefinition(CreateFunctionDefinitionRequest createFunctionDefinitionRequest)`	Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.
`default CreateFunctionDefinitionVersionResponse`	`createFunctionDefinitionVersion(CreateFunctionDefinitionVersionRequest createFunctionDefinitionVersionRequest)`	Create a version of a Lambda function definition that has already been defined.
`default CreateGroupResponse`	`createGroup(CreateGroupRequest createGroupRequest)`	Creates a group.
`default CreateGroupCertificateAuthorityResponse`	`createGroupCertificateAuthority(CreateGroupCertificateAuthorityRequest createGroupCertificateAuthorityRequest)`	Creates a CA for the group.
`default CreateGroupVersionResponse`	`createGroupVersion(CreateGroupVersionRequest createGroupVersionRequest)`	Creates a version of a group which has already been defined.
`default CreateLoggerDefinitionResponse`	`createLoggerDefinition(CreateLoggerDefinitionRequest createLoggerDefinitionRequest)`	Creates a logger definition.
`default CreateLoggerDefinitionVersionResponse`	`createLoggerDefinitionVersion(CreateLoggerDefinitionVersionRequest createLoggerDefinitionVersionRequest)`	Creates a version of a logger definition that has already been defined.
`default CreateSubscriptionDefinitionResponse`	`createSubscriptionDefinition(CreateSubscriptionDefinitionRequest createSubscriptionDefinitionRequest)`	Creates a subscription definition.
`default CreateSubscriptionDefinitionVersionResponse`	`createSubscriptionDefinitionVersion(CreateSubscriptionDefinitionVersionRequest createSubscriptionDefinitionVersionRequest)`	Creates a version of a subscription definition which has already been defined.
`default DeleteCoreDefinitionResponse`	`deleteCoreDefinition(DeleteCoreDefinitionRequest deleteCoreDefinitionRequest)`	Deletes a core definition.
`default DeleteDeviceDefinitionResponse`	`deleteDeviceDefinition(DeleteDeviceDefinitionRequest deleteDeviceDefinitionRequest)`	Deletes a device definition.
`default DeleteFunctionDefinitionResponse`	`deleteFunctionDefinition(DeleteFunctionDefinitionRequest deleteFunctionDefinitionRequest)`	Deletes a Lambda function definition.
`default DeleteGroupResponse`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)`	Deletes a group.
`default DeleteLoggerDefinitionResponse`	`deleteLoggerDefinition(DeleteLoggerDefinitionRequest deleteLoggerDefinitionRequest)`	Deletes a logger definition.
`default DeleteSubscriptionDefinitionResponse`	`deleteSubscriptionDefinition(DeleteSubscriptionDefinitionRequest deleteSubscriptionDefinitionRequest)`	Deletes a subscription definition.
`default DisassociateRoleFromGroupResponse`	`disassociateRoleFromGroup(DisassociateRoleFromGroupRequest disassociateRoleFromGroupRequest)`	Disassociates the role from a group.
`default DisassociateServiceRoleFromAccountResponse`	`disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest)`	Disassociates the service role from the account.
`default GetAssociatedRoleResponse`	`getAssociatedRole(GetAssociatedRoleRequest getAssociatedRoleRequest)`	Retrieves the role associated with a particular group.
`default GetConnectivityInfoResponse`	`getConnectivityInfo(GetConnectivityInfoRequest getConnectivityInfoRequest)`	Retrieves the connectivity information for a core.
`default GetCoreDefinitionResponse`	`getCoreDefinition(GetCoreDefinitionRequest getCoreDefinitionRequest)`	Retrieves information about a core definition version.
`default GetCoreDefinitionVersionResponse`	`getCoreDefinitionVersion(GetCoreDefinitionVersionRequest getCoreDefinitionVersionRequest)`	Retrieves information about a core definition version.
`default GetDeploymentStatusResponse`	`getDeploymentStatus(GetDeploymentStatusRequest getDeploymentStatusRequest)`	Returns the status of a deployment.
`default GetDeviceDefinitionResponse`	`getDeviceDefinition(GetDeviceDefinitionRequest getDeviceDefinitionRequest)`	Retrieves information about a device definition.
`default GetDeviceDefinitionVersionResponse`	`getDeviceDefinitionVersion(GetDeviceDefinitionVersionRequest getDeviceDefinitionVersionRequest)`	Retrieves information about a device definition version.
`default GetFunctionDefinitionResponse`	`getFunctionDefinition(GetFunctionDefinitionRequest getFunctionDefinitionRequest)`	Retrieves information about a Lambda function definition, such as its creation time and latest version.
`default GetFunctionDefinitionVersionResponse`	`getFunctionDefinitionVersion(GetFunctionDefinitionVersionRequest getFunctionDefinitionVersionRequest)`	Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.
`default GetGroupResponse`	`getGroup(GetGroupRequest getGroupRequest)`	Retrieves information about a group.
`default GetGroupCertificateAuthorityResponse`	`getGroupCertificateAuthority(GetGroupCertificateAuthorityRequest getGroupCertificateAuthorityRequest)`	Retreives the CA associated with a group.
`default GetGroupCertificateConfigurationResponse`	`getGroupCertificateConfiguration(GetGroupCertificateConfigurationRequest getGroupCertificateConfigurationRequest)`	Retrieves the current configuration for the CA used by the group.
`default GetGroupVersionResponse`	`getGroupVersion(GetGroupVersionRequest getGroupVersionRequest)`	Retrieves information about a group version.
`default GetLoggerDefinitionResponse`	`getLoggerDefinition(GetLoggerDefinitionRequest getLoggerDefinitionRequest)`	Retrieves information about a logger definition.
`default GetLoggerDefinitionVersionResponse`	`getLoggerDefinitionVersion(GetLoggerDefinitionVersionRequest getLoggerDefinitionVersionRequest)`	Retrieves information about a logger definition version.
`default GetServiceRoleForAccountResponse`	`getServiceRoleForAccount(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest)`	Retrieves the service role that is attached to the account.
`default GetSubscriptionDefinitionResponse`	`getSubscriptionDefinition(GetSubscriptionDefinitionRequest getSubscriptionDefinitionRequest)`	Retrieves information about a subscription definition.
`default GetSubscriptionDefinitionVersionResponse`	`getSubscriptionDefinitionVersion(GetSubscriptionDefinitionVersionRequest getSubscriptionDefinitionVersionRequest)`	Retrieves information about a subscription definition version.
`default ListCoreDefinitionsResponse`	`listCoreDefinitions(ListCoreDefinitionsRequest listCoreDefinitionsRequest)`	Retrieves a list of core definitions.
`default ListCoreDefinitionVersionsResponse`	`listCoreDefinitionVersions(ListCoreDefinitionVersionsRequest listCoreDefinitionVersionsRequest)`	Lists versions of a core definition.
`default ListDeploymentsResponse`	`listDeployments(ListDeploymentsRequest listDeploymentsRequest)`	Returns a history of deployments for the group.
`default ListDeviceDefinitionsResponse`	`listDeviceDefinitions(ListDeviceDefinitionsRequest listDeviceDefinitionsRequest)`	Retrieves a list of device definitions.
`default ListDeviceDefinitionVersionsResponse`	`listDeviceDefinitionVersions(ListDeviceDefinitionVersionsRequest listDeviceDefinitionVersionsRequest)`	Lists the versions of a device definition.
`default ListFunctionDefinitionsResponse`	`listFunctionDefinitions(ListFunctionDefinitionsRequest listFunctionDefinitionsRequest)`	Retrieves a list of Lambda function definitions.
`default ListFunctionDefinitionVersionsResponse`	`listFunctionDefinitionVersions(ListFunctionDefinitionVersionsRequest listFunctionDefinitionVersionsRequest)`	Lists the versions of a Lambda function definition.
`default ListGroupCertificateAuthoritiesResponse`	`listGroupCertificateAuthorities(ListGroupCertificateAuthoritiesRequest listGroupCertificateAuthoritiesRequest)`	Retrieves the current CAs for a group.
`default ListGroupsResponse`	`listGroups(ListGroupsRequest listGroupsRequest)`	Retrieves a list of groups.
`default ListGroupVersionsResponse`	`listGroupVersions(ListGroupVersionsRequest listGroupVersionsRequest)`	List the versions of a group.
`default ListLoggerDefinitionsResponse`	`listLoggerDefinitions(ListLoggerDefinitionsRequest listLoggerDefinitionsRequest)`	Retrieves a list of logger definitions.
`default ListLoggerDefinitionVersionsResponse`	`listLoggerDefinitionVersions(ListLoggerDefinitionVersionsRequest listLoggerDefinitionVersionsRequest)`	Lists the versions of a logger definition.
`default ListSubscriptionDefinitionsResponse`	`listSubscriptionDefinitions(ListSubscriptionDefinitionsRequest listSubscriptionDefinitionsRequest)`	Retrieves a list of subscription definitions.
`default ListSubscriptionDefinitionVersionsResponse`	`listSubscriptionDefinitionVersions(ListSubscriptionDefinitionVersionsRequest listSubscriptionDefinitionVersionsRequest)`	Lists the versions of a subscription definition.
`static ServiceMetadata`	`serviceMetadata()`
`default UpdateConnectivityInfoResponse`	`updateConnectivityInfo(UpdateConnectivityInfoRequest updateConnectivityInfoRequest)`	Updates the connectivity information for the core.
`default UpdateCoreDefinitionResponse`	`updateCoreDefinition(UpdateCoreDefinitionRequest updateCoreDefinitionRequest)`	Updates a core definition.
`default UpdateDeviceDefinitionResponse`	`updateDeviceDefinition(UpdateDeviceDefinitionRequest updateDeviceDefinitionRequest)`	Updates a device definition.
`default UpdateFunctionDefinitionResponse`	`updateFunctionDefinition(UpdateFunctionDefinitionRequest updateFunctionDefinitionRequest)`	Updates a Lambda function definition.
`default UpdateGroupResponse`	`updateGroup(UpdateGroupRequest updateGroupRequest)`	Updates a group.
`default UpdateGroupCertificateConfigurationResponse`	`updateGroupCertificateConfiguration(UpdateGroupCertificateConfigurationRequest updateGroupCertificateConfigurationRequest)`	Updates the Cert expiry time for a group.
`default UpdateLoggerDefinitionResponse`	`updateLoggerDefinition(UpdateLoggerDefinitionRequest updateLoggerDefinitionRequest)`	Updates a logger definition.
`default UpdateSubscriptionDefinitionResponse`	`updateSubscriptionDefinition(UpdateSubscriptionDefinitionRequest updateSubscriptionDefinitionRequest)`	Updates a subscription definition.

Methods inherited from interface java.lang.AutoCloseable
close

Field Detail
- SERVICE_NAME
```
static final String SERVICE_NAME
```
  See Also:
  
  Constant Field Values

Method Detail

create
```
static GreengrassClient create()
```
Create a GreengrassClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder
```
static GreengrassClientBuilder builder()
```
Create a builder that can be used to configure and create a GreengrassClient.

associateRoleToGroup
```
default AssociateRoleToGroupResponse associateRoleToGroup(AssociateRoleToGroupRequest associateRoleToGroupRequest)
                                                   throws BadRequestException,
                                                          InternalServerErrorException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          GreengrassException
```
Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.

Parameters:

associateRoleToGroupRequest -

Returns:

Result of the AssociateRoleToGroup operation returned by the service.

Throws:

BadRequestException - User Error

InternalServerErrorException - Server Error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

associateServiceRoleToAccount

default AssociateServiceRoleToAccountResponse associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest)
                                                                     throws BadRequestException,
                                                                            InternalServerErrorException,
                                                                            SdkBaseException,
                                                                            SdkClientException,
                                                                            GreengrassException

Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy ``AWSGreengrassResourceAccessRolePolicy``

Parameters:: associateServiceRoleToAccountRequest -
Returns:: Result of the AssociateServiceRoleToAccount operation returned by the service.
Throws:: BadRequestException - User Error; InternalServerErrorException - Server Error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

createCoreDefinition
```
default CreateCoreDefinitionResponse createCoreDefinition(CreateCoreDefinitionRequest createCoreDefinitionRequest)
                                                   throws BadRequestException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          GreengrassException
```
Creates a core definition. You may optionally provide the initial version of the core definition or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Parameters:

createCoreDefinitionRequest - Information on the core definition request

Returns:

Result of the CreateCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createCoreDefinitionVersion
```
default CreateCoreDefinitionVersionResponse createCoreDefinitionVersion(CreateCoreDefinitionVersionRequest createCoreDefinitionVersionRequest)
                                                                 throws BadRequestException,
                                                                        SdkBaseException,
                                                                        SdkClientException,
                                                                        GreengrassException
```
Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Parameters:

createCoreDefinitionVersionRequest -

Returns:

Result of the CreateCoreDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createDeployment
```
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest)
                                           throws BadRequestException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  GreengrassException
```
Creates a deployment.

Parameters:

createDeploymentRequest -

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

BadRequestException - This request was invalid.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createDeviceDefinition
```
default CreateDeviceDefinitionResponse createDeviceDefinition(CreateDeviceDefinitionRequest createDeviceDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException
```
Creates a device definition. You may optinally provide the initial version of the device definition or use ``CreateDeviceDefinitionVersion`` at a later time.

Parameters:

createDeviceDefinitionRequest -

Returns:

Result of the CreateDeviceDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createDeviceDefinitionVersion

default CreateDeviceDefinitionVersionResponse createDeviceDefinitionVersion(CreateDeviceDefinitionVersionRequest createDeviceDefinitionVersionRequest)
                                                                     throws BadRequestException,
                                                                            SdkBaseException,
                                                                            SdkClientException,
                                                                            GreengrassException

Creates a version of a device definition that has already been defined.

Parameters:: createDeviceDefinitionVersionRequest -
Returns:: Result of the CreateDeviceDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

createFunctionDefinition
```
default CreateFunctionDefinitionResponse createFunctionDefinition(CreateFunctionDefinitionRequest createFunctionDefinitionRequest)
                                                           throws BadRequestException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  GreengrassException
```
Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ``CreateFunctionDefinitionVersion`` later.

Parameters:

createFunctionDefinitionRequest -

Returns:

Result of the CreateFunctionDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createFunctionDefinitionVersion

default CreateFunctionDefinitionVersionResponse createFunctionDefinitionVersion(CreateFunctionDefinitionVersionRequest createFunctionDefinitionVersionRequest)
                                                                         throws BadRequestException,
                                                                                SdkBaseException,
                                                                                SdkClientException,
                                                                                GreengrassException

Create a version of a Lambda function definition that has already been defined.

Parameters:: createFunctionDefinitionVersionRequest - Function definition version
Returns:: Result of the CreateFunctionDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

createGroup
```
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest)
                                 throws BadRequestException,
                                        SdkBaseException,
                                        SdkClientException,
                                        GreengrassException
```
Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.

Parameters:

createGroupRequest -

Returns:

Result of the CreateGroup operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createGroupCertificateAuthority

default CreateGroupCertificateAuthorityResponse createGroupCertificateAuthority(CreateGroupCertificateAuthorityRequest createGroupCertificateAuthorityRequest)
                                                                         throws BadRequestException,
                                                                                InternalServerErrorException,
                                                                                SdkBaseException,
                                                                                SdkClientException,
                                                                                GreengrassException

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Parameters:: createGroupCertificateAuthorityRequest -
Returns:: Result of the CreateGroupCertificateAuthority operation returned by the service.
Throws:: BadRequestException - This request was invalid.; InternalServerErrorException - The server encountered an unexpected error.; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

createGroupVersion
```
default CreateGroupVersionResponse createGroupVersion(CreateGroupVersionRequest createGroupVersionRequest)
                                               throws BadRequestException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      GreengrassException
```
Creates a version of a group which has already been defined.

Parameters:

createGroupVersionRequest -

Returns:

Result of the CreateGroupVersion operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createLoggerDefinition
```
default CreateLoggerDefinitionResponse createLoggerDefinition(CreateLoggerDefinitionRequest createLoggerDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException
```
Creates a logger definition. You may optionally provide the initial version of the logger definition or use ``CreateLoggerDefinitionVersion`` at a later time.

Parameters:

createLoggerDefinitionRequest -

Returns:

Result of the CreateLoggerDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createLoggerDefinitionVersion

default CreateLoggerDefinitionVersionResponse createLoggerDefinitionVersion(CreateLoggerDefinitionVersionRequest createLoggerDefinitionVersionRequest)
                                                                     throws BadRequestException,
                                                                            SdkBaseException,
                                                                            SdkClientException,
                                                                            GreengrassException

Creates a version of a logger definition that has already been defined.

Parameters:: createLoggerDefinitionVersionRequest -
Returns:: Result of the CreateLoggerDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

createSubscriptionDefinition
```
default CreateSubscriptionDefinitionResponse createSubscriptionDefinition(CreateSubscriptionDefinitionRequest createSubscriptionDefinitionRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException
```
Creates a subscription definition. You may optionally provide the initial version of the subscription definition or use ``CreateSubscriptionDefinitionVersion`` at a later time.

Parameters:

createSubscriptionDefinitionRequest -

Returns:

Result of the CreateSubscriptionDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createSubscriptionDefinitionVersion

default CreateSubscriptionDefinitionVersionResponse createSubscriptionDefinitionVersion(CreateSubscriptionDefinitionVersionRequest createSubscriptionDefinitionVersionRequest)
                                                                                 throws BadRequestException,
                                                                                        SdkBaseException,
                                                                                        SdkClientException,
                                                                                        GreengrassException

Creates a version of a subscription definition which has already been defined.

Parameters:: createSubscriptionDefinitionVersionRequest -
Returns:: Result of the CreateSubscriptionDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

deleteCoreDefinition
```
default DeleteCoreDefinitionResponse deleteCoreDefinition(DeleteCoreDefinitionRequest deleteCoreDefinitionRequest)
                                                   throws BadRequestException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          GreengrassException
```
Deletes a core definition. The core definition must not have been used in a deployment.

Parameters:

deleteCoreDefinitionRequest -

Returns:

Result of the DeleteCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteDeviceDefinition
```
default DeleteDeviceDefinitionResponse deleteDeviceDefinition(DeleteDeviceDefinitionRequest deleteDeviceDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException
```
Deletes a device definition. The device definition must not have been used in a deployment.

Parameters:

deleteDeviceDefinitionRequest -

Returns:

Result of the DeleteDeviceDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteFunctionDefinition
```
default DeleteFunctionDefinitionResponse deleteFunctionDefinition(DeleteFunctionDefinitionRequest deleteFunctionDefinitionRequest)
                                                           throws BadRequestException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  GreengrassException
```
Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.

Parameters:

deleteFunctionDefinitionRequest -

Returns:

Result of the DeleteFunctionDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteGroup
```
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest)
                                 throws BadRequestException,
                                        SdkBaseException,
                                        SdkClientException,
                                        GreengrassException
```
Deletes a group. The group must not have been used in deployment.

Parameters:

deleteGroupRequest -

Returns:

Result of the DeleteGroup operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteLoggerDefinition
```
default DeleteLoggerDefinitionResponse deleteLoggerDefinition(DeleteLoggerDefinitionRequest deleteLoggerDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException
```
Deletes a logger definition. The logger definition must not have been used in a deployment.

Parameters:

deleteLoggerDefinitionRequest -

Returns:

Result of the DeleteLoggerDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteSubscriptionDefinition

default DeleteSubscriptionDefinitionResponse deleteSubscriptionDefinition(DeleteSubscriptionDefinitionRequest deleteSubscriptionDefinitionRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException

Deletes a subscription definition. The subscription definition must not have been used in a deployment.

Parameters:: deleteSubscriptionDefinitionRequest -
Returns:: Result of the DeleteSubscriptionDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

disassociateRoleFromGroup

default DisassociateRoleFromGroupResponse disassociateRoleFromGroup(DisassociateRoleFromGroupRequest disassociateRoleFromGroupRequest)
                                                             throws BadRequestException,
                                                                    InternalServerErrorException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    GreengrassException

Disassociates the role from a group.

Parameters:: disassociateRoleFromGroupRequest -
Returns:: Result of the DisassociateRoleFromGroup operation returned by the service.
Throws:: BadRequestException - User Error; InternalServerErrorException - Server Error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

disassociateServiceRoleFromAccount

default DisassociateServiceRoleFromAccountResponse disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest)
                                                                               throws InternalServerErrorException,
                                                                                      SdkBaseException,
                                                                                      SdkClientException,
                                                                                      GreengrassException

Disassociates the service role from the account. Without a service role, deployments will not work.

Parameters:: disassociateServiceRoleFromAccountRequest -
Returns:: Result of the DisassociateServiceRoleFromAccount operation returned by the service.
Throws:: InternalServerErrorException - Server Error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getAssociatedRole

default GetAssociatedRoleResponse getAssociatedRole(GetAssociatedRoleRequest getAssociatedRoleRequest)
                                             throws BadRequestException,
                                                    InternalServerErrorException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    GreengrassException

Retrieves the role associated with a particular group.

Parameters:: getAssociatedRoleRequest -
Returns:: Result of the GetAssociatedRole operation returned by the service.
Throws:: BadRequestException - User Error; InternalServerErrorException - Server Error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getConnectivityInfo

default GetConnectivityInfoResponse getConnectivityInfo(GetConnectivityInfoRequest getConnectivityInfoRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        GreengrassException

Retrieves the connectivity information for a core.

Parameters:: getConnectivityInfoRequest -
Returns:: Result of the GetConnectivityInfo operation returned by the service.
Throws:: BadRequestException - 400 response; InternalServerErrorException - 500 response; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getCoreDefinition
```
default GetCoreDefinitionResponse getCoreDefinition(GetCoreDefinitionRequest getCoreDefinitionRequest)
                                             throws BadRequestException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    GreengrassException
```
Retrieves information about a core definition version.

Parameters:

getCoreDefinitionRequest -

Returns:

Result of the GetCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getCoreDefinitionVersion

default GetCoreDefinitionVersionResponse getCoreDefinitionVersion(GetCoreDefinitionVersionRequest getCoreDefinitionVersionRequest)
                                                           throws BadRequestException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  GreengrassException

Retrieves information about a core definition version.

Parameters:: getCoreDefinitionVersionRequest -
Returns:: Result of the GetCoreDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getDeploymentStatus
```
default GetDeploymentStatusResponse getDeploymentStatus(GetDeploymentStatusRequest getDeploymentStatusRequest)
                                                 throws BadRequestException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        GreengrassException
```
Returns the status of a deployment.

Parameters:

getDeploymentStatusRequest -

Returns:

Result of the GetDeploymentStatus operation returned by the service.

Throws:

BadRequestException - This request was invalid.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getDeviceDefinition
```
default GetDeviceDefinitionResponse getDeviceDefinition(GetDeviceDefinitionRequest getDeviceDefinitionRequest)
                                                 throws BadRequestException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        GreengrassException
```
Retrieves information about a device definition.

Parameters:

getDeviceDefinitionRequest -

Returns:

Result of the GetDeviceDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getDeviceDefinitionVersion

default GetDeviceDefinitionVersionResponse getDeviceDefinitionVersion(GetDeviceDefinitionVersionRequest getDeviceDefinitionVersionRequest)
                                                               throws BadRequestException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      GreengrassException

Retrieves information about a device definition version.

Parameters:: getDeviceDefinitionVersionRequest -
Returns:: Result of the GetDeviceDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getFunctionDefinition
```
default GetFunctionDefinitionResponse getFunctionDefinition(GetFunctionDefinitionRequest getFunctionDefinitionRequest)
                                                     throws BadRequestException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            GreengrassException
```
Retrieves information about a Lambda function definition, such as its creation time and latest version.

Parameters:

getFunctionDefinitionRequest -

Returns:

Result of the GetFunctionDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getFunctionDefinitionVersion
```
default GetFunctionDefinitionVersionResponse getFunctionDefinitionVersion(GetFunctionDefinitionVersionRequest getFunctionDefinitionVersionRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException
```
Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.

Parameters:

getFunctionDefinitionVersionRequest -

Returns:

Result of the GetFunctionDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getGroup
```
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest)
                           throws BadRequestException,
                                  SdkBaseException,
                                  SdkClientException,
                                  GreengrassException
```
Retrieves information about a group.

Parameters:

getGroupRequest -

Returns:

Result of the GetGroup operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getGroupCertificateAuthority

default GetGroupCertificateAuthorityResponse getGroupCertificateAuthority(GetGroupCertificateAuthorityRequest getGroupCertificateAuthorityRequest)
                                                                   throws BadRequestException,
                                                                          InternalServerErrorException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException

Retreives the CA associated with a group. Returns the public key of the CA.

Parameters:: getGroupCertificateAuthorityRequest -
Returns:: Result of the GetGroupCertificateAuthority operation returned by the service.
Throws:: BadRequestException - This request was invalid.; InternalServerErrorException - This request was invalid.; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getGroupCertificateConfiguration

default GetGroupCertificateConfigurationResponse getGroupCertificateConfiguration(GetGroupCertificateConfigurationRequest getGroupCertificateConfigurationRequest)
                                                                           throws BadRequestException,
                                                                                  InternalServerErrorException,
                                                                                  SdkBaseException,
                                                                                  SdkClientException,
                                                                                  GreengrassException

Retrieves the current configuration for the CA used by the group.

Parameters:: getGroupCertificateConfigurationRequest -
Returns:: Result of the GetGroupCertificateConfiguration operation returned by the service.
Throws:: BadRequestException - This request was invalid.; InternalServerErrorException - This request was invalid.; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getGroupVersion
```
default GetGroupVersionResponse getGroupVersion(GetGroupVersionRequest getGroupVersionRequest)
                                         throws BadRequestException,
                                                SdkBaseException,
                                                SdkClientException,
                                                GreengrassException
```
Retrieves information about a group version.

Parameters:

getGroupVersionRequest -

Returns:

Result of the GetGroupVersion operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getLoggerDefinition
```
default GetLoggerDefinitionResponse getLoggerDefinition(GetLoggerDefinitionRequest getLoggerDefinitionRequest)
                                                 throws BadRequestException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        GreengrassException
```
Retrieves information about a logger definition.

Parameters:

getLoggerDefinitionRequest -

Returns:

Result of the GetLoggerDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getLoggerDefinitionVersion

default GetLoggerDefinitionVersionResponse getLoggerDefinitionVersion(GetLoggerDefinitionVersionRequest getLoggerDefinitionVersionRequest)
                                                               throws BadRequestException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      GreengrassException

Retrieves information about a logger definition version.

Parameters:: getLoggerDefinitionVersionRequest -
Returns:: Result of the GetLoggerDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getServiceRoleForAccount

default GetServiceRoleForAccountResponse getServiceRoleForAccount(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest)
                                                           throws InternalServerErrorException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  GreengrassException

Retrieves the service role that is attached to the account.

Parameters:: getServiceRoleForAccountRequest -
Returns:: Result of the GetServiceRoleForAccount operation returned by the service.
Throws:: InternalServerErrorException - Server Error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getSubscriptionDefinition

default GetSubscriptionDefinitionResponse getSubscriptionDefinition(GetSubscriptionDefinitionRequest getSubscriptionDefinitionRequest)
                                                             throws BadRequestException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    GreengrassException

Retrieves information about a subscription definition.

Parameters:: getSubscriptionDefinitionRequest -
Returns:: Result of the GetSubscriptionDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

getSubscriptionDefinitionVersion

default GetSubscriptionDefinitionVersionResponse getSubscriptionDefinitionVersion(GetSubscriptionDefinitionVersionRequest getSubscriptionDefinitionVersionRequest)
                                                                           throws BadRequestException,
                                                                                  SdkBaseException,
                                                                                  SdkClientException,
                                                                                  GreengrassException

Retrieves information about a subscription definition version.

Parameters:: getSubscriptionDefinitionVersionRequest -
Returns:: Result of the GetSubscriptionDefinitionVersion operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listCoreDefinitionVersions

default ListCoreDefinitionVersionsResponse listCoreDefinitionVersions(ListCoreDefinitionVersionsRequest listCoreDefinitionVersionsRequest)
                                                               throws BadRequestException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      GreengrassException

Lists versions of a core definition.

Parameters:: listCoreDefinitionVersionsRequest -
Returns:: Result of the ListCoreDefinitionVersions operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listCoreDefinitions

default ListCoreDefinitionsResponse listCoreDefinitions(ListCoreDefinitionsRequest listCoreDefinitionsRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        GreengrassException

Retrieves a list of core definitions.

Parameters:: listCoreDefinitionsRequest -
Returns:: Result of the ListCoreDefinitions operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

listDeployments
```
default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest)
                                         throws BadRequestException,
                                                SdkBaseException,
                                                SdkClientException,
                                                GreengrassException
```
Returns a history of deployments for the group.

Parameters:

listDeploymentsRequest -

Returns:

Result of the ListDeployments operation returned by the service.

Throws:

BadRequestException - This request was invalid.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listDeviceDefinitionVersions

default ListDeviceDefinitionVersionsResponse listDeviceDefinitionVersions(ListDeviceDefinitionVersionsRequest listDeviceDefinitionVersionsRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException

Lists the versions of a device definition.

Parameters:: listDeviceDefinitionVersionsRequest -
Returns:: Result of the ListDeviceDefinitionVersions operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listDeviceDefinitions

default ListDeviceDefinitionsResponse listDeviceDefinitions(ListDeviceDefinitionsRequest listDeviceDefinitionsRequest)
                                                     throws SdkBaseException,
                                                            SdkClientException,
                                                            GreengrassException

Retrieves a list of device definitions.

Parameters:: listDeviceDefinitionsRequest -
Returns:: Result of the ListDeviceDefinitions operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

listFunctionDefinitionVersions

default ListFunctionDefinitionVersionsResponse listFunctionDefinitionVersions(ListFunctionDefinitionVersionsRequest listFunctionDefinitionVersionsRequest)
                                                                       throws BadRequestException,
                                                                              SdkBaseException,
                                                                              SdkClientException,
                                                                              GreengrassException

Lists the versions of a Lambda function definition.

Parameters:: listFunctionDefinitionVersionsRequest -
Returns:: Result of the ListFunctionDefinitionVersions operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listFunctionDefinitions

default ListFunctionDefinitionsResponse listFunctionDefinitions(ListFunctionDefinitionsRequest listFunctionDefinitionsRequest)
                                                         throws SdkBaseException,
                                                                SdkClientException,
                                                                GreengrassException

Retrieves a list of Lambda function definitions.

Parameters:: listFunctionDefinitionsRequest -
Returns:: Result of the ListFunctionDefinitions operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

listGroupCertificateAuthorities

default ListGroupCertificateAuthoritiesResponse listGroupCertificateAuthorities(ListGroupCertificateAuthoritiesRequest listGroupCertificateAuthoritiesRequest)
                                                                         throws BadRequestException,
                                                                                InternalServerErrorException,
                                                                                SdkBaseException,
                                                                                SdkClientException,
                                                                                GreengrassException

Retrieves the current CAs for a group.

Parameters:: listGroupCertificateAuthoritiesRequest -
Returns:: Result of the ListGroupCertificateAuthorities operation returned by the service.
Throws:: BadRequestException - This request was invalid.; InternalServerErrorException - This request was invalid.; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listGroupVersions
```
default ListGroupVersionsResponse listGroupVersions(ListGroupVersionsRequest listGroupVersionsRequest)
                                             throws BadRequestException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    GreengrassException
```
List the versions of a group.

Parameters:

listGroupVersionsRequest -

Returns:

Result of the ListGroupVersions operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listGroups

default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest)
                               throws SdkBaseException,
                                      SdkClientException,
                                      GreengrassException

Retrieves a list of groups.

Parameters:: listGroupsRequest -
Returns:: Result of the ListGroups operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

listLoggerDefinitionVersions

default ListLoggerDefinitionVersionsResponse listLoggerDefinitionVersions(ListLoggerDefinitionVersionsRequest listLoggerDefinitionVersionsRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException

Lists the versions of a logger definition.

Parameters:: listLoggerDefinitionVersionsRequest -
Returns:: Result of the ListLoggerDefinitionVersions operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listLoggerDefinitions

default ListLoggerDefinitionsResponse listLoggerDefinitions(ListLoggerDefinitionsRequest listLoggerDefinitionsRequest)
                                                     throws SdkBaseException,
                                                            SdkClientException,
                                                            GreengrassException

Retrieves a list of logger definitions.

Parameters:: listLoggerDefinitionsRequest -
Returns:: Result of the ListLoggerDefinitions operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

listSubscriptionDefinitionVersions

default ListSubscriptionDefinitionVersionsResponse listSubscriptionDefinitionVersions(ListSubscriptionDefinitionVersionsRequest listSubscriptionDefinitionVersionsRequest)
                                                                               throws BadRequestException,
                                                                                      SdkBaseException,
                                                                                      SdkClientException,
                                                                                      GreengrassException

Lists the versions of a subscription definition.

Parameters:: listSubscriptionDefinitionVersionsRequest -
Returns:: Result of the ListSubscriptionDefinitionVersions operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

listSubscriptionDefinitions

default ListSubscriptionDefinitionsResponse listSubscriptionDefinitions(ListSubscriptionDefinitionsRequest listSubscriptionDefinitionsRequest)
                                                                 throws SdkBaseException,
                                                                        SdkClientException,
                                                                        GreengrassException

Retrieves a list of subscription definitions.

Parameters:: listSubscriptionDefinitionsRequest -
Returns:: Result of the ListSubscriptionDefinitions operation returned by the service.
Throws:: SdkBaseException; SdkClientException; GreengrassException
See Also:: AWS API Documentation

updateConnectivityInfo
```
default UpdateConnectivityInfoResponse updateConnectivityInfo(UpdateConnectivityInfoRequest updateConnectivityInfoRequest)
                                                       throws BadRequestException,
                                                              InternalServerErrorException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException
```
Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

Parameters:

updateConnectivityInfoRequest - connectivity info request

Returns:

Result of the UpdateConnectivityInfo operation returned by the service.

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateCoreDefinition
```
default UpdateCoreDefinitionResponse updateCoreDefinition(UpdateCoreDefinitionRequest updateCoreDefinitionRequest)
                                                   throws BadRequestException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          GreengrassException
```
Updates a core definition.

Parameters:

updateCoreDefinitionRequest -

Returns:

Result of the UpdateCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateDeviceDefinition

default UpdateDeviceDefinitionResponse updateDeviceDefinition(UpdateDeviceDefinitionRequest updateDeviceDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException

Updates a device definition.

Parameters:: updateDeviceDefinitionRequest -
Returns:: Result of the UpdateDeviceDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

updateFunctionDefinition

default UpdateFunctionDefinitionResponse updateFunctionDefinition(UpdateFunctionDefinitionRequest updateFunctionDefinitionRequest)
                                                           throws BadRequestException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  GreengrassException

Updates a Lambda function definition.

Parameters:: updateFunctionDefinitionRequest -
Returns:: Result of the UpdateFunctionDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

updateGroup
```
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest)
                                 throws BadRequestException,
                                        SdkBaseException,
                                        SdkClientException,
                                        GreengrassException
```
Updates a group.

Parameters:

updateGroupRequest -

Returns:

Result of the UpdateGroup operation returned by the service.

Throws:

BadRequestException - user error

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateGroupCertificateConfiguration

default UpdateGroupCertificateConfigurationResponse updateGroupCertificateConfiguration(UpdateGroupCertificateConfigurationRequest updateGroupCertificateConfigurationRequest)
                                                                                 throws BadRequestException,
                                                                                        InternalServerErrorException,
                                                                                        SdkBaseException,
                                                                                        SdkClientException,
                                                                                        GreengrassException

Updates the Cert expiry time for a group.

Parameters:: updateGroupCertificateConfigurationRequest -
Returns:: Result of the UpdateGroupCertificateConfiguration operation returned by the service.
Throws:: BadRequestException - This request was invalid.; InternalServerErrorException - This request was invalid.; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

updateLoggerDefinition

default UpdateLoggerDefinitionResponse updateLoggerDefinition(UpdateLoggerDefinitionRequest updateLoggerDefinitionRequest)
                                                       throws BadRequestException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              GreengrassException

Updates a logger definition.

Parameters:: updateLoggerDefinitionRequest -
Returns:: Result of the UpdateLoggerDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

updateSubscriptionDefinition

default UpdateSubscriptionDefinitionResponse updateSubscriptionDefinition(UpdateSubscriptionDefinitionRequest updateSubscriptionDefinitionRequest)
                                                                   throws BadRequestException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          GreengrassException

Updates a subscription definition.

Parameters:: updateSubscriptionDefinitionRequest -
Returns:: Result of the UpdateSubscriptionDefinition operation returned by the service.
Throws:: BadRequestException - user error; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); GreengrassException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
See Also:: AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()

Interface GreengrassClient

Field Summary

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE_NAME

Method Detail

create

builder

associateRoleToGroup

associateServiceRoleToAccount

createCoreDefinition

createCoreDefinitionVersion

createDeployment

createDeviceDefinition

createDeviceDefinitionVersion

createFunctionDefinition

createFunctionDefinitionVersion

createGroup

createGroupCertificateAuthority

createGroupVersion

createLoggerDefinition

createLoggerDefinitionVersion

createSubscriptionDefinition

createSubscriptionDefinitionVersion

deleteCoreDefinition

deleteDeviceDefinition

deleteFunctionDefinition

deleteGroup

deleteLoggerDefinition