com.amazonaws.services.greengrass

Interface AWSGreengrass

All Known Subinterfaces:

AWSGreengrassAsync

All Known Implementing Classes:

AbstractAWSGreengrass, AbstractAWSGreengrassAsync, AWSGreengrassAsyncClient, AWSGreengrassClient

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

Interface for accessing AWS Greengrass.

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

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateRoleToGroupResult	associateRoleToGroup(AssociateRoleToGroupRequest associateRoleToGroupRequest) Associates a role with a group.
AssociateServiceRoleToAccountResult	associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest) Associates a role which is used by AWS Greengrass.
CreateCoreDefinitionResult	createCoreDefinition(CreateCoreDefinitionRequest createCoreDefinitionRequest) Creates a core definition.
CreateCoreDefinitionVersionResult	createCoreDefinitionVersion(CreateCoreDefinitionVersionRequest createCoreDefinitionVersionRequest) Creates a version of a core definition that has already been defined.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest createDeploymentRequest) Creates a deployment.
CreateDeviceDefinitionResult	createDeviceDefinition(CreateDeviceDefinitionRequest createDeviceDefinitionRequest) Creates a device definition.
CreateDeviceDefinitionVersionResult	createDeviceDefinitionVersion(CreateDeviceDefinitionVersionRequest createDeviceDefinitionVersionRequest) Creates a version of a device definition that has already been defined.
CreateFunctionDefinitionResult	createFunctionDefinition(CreateFunctionDefinitionRequest createFunctionDefinitionRequest) Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.
CreateFunctionDefinitionVersionResult	createFunctionDefinitionVersion(CreateFunctionDefinitionVersionRequest createFunctionDefinitionVersionRequest) Create a version of a Lambda function definition that has already been defined.
CreateGroupResult	createGroup(CreateGroupRequest createGroupRequest) Creates a group.
CreateGroupCertificateAuthorityResult	createGroupCertificateAuthority(CreateGroupCertificateAuthorityRequest createGroupCertificateAuthorityRequest) Creates a CA for the group.
CreateGroupVersionResult	createGroupVersion(CreateGroupVersionRequest createGroupVersionRequest) Creates a version of a group which has already been defined.
CreateLoggerDefinitionResult	createLoggerDefinition(CreateLoggerDefinitionRequest createLoggerDefinitionRequest) Creates a logger definition.
CreateLoggerDefinitionVersionResult	createLoggerDefinitionVersion(CreateLoggerDefinitionVersionRequest createLoggerDefinitionVersionRequest) Creates a version of a logger definition that has already been defined.
CreateSubscriptionDefinitionResult	createSubscriptionDefinition(CreateSubscriptionDefinitionRequest createSubscriptionDefinitionRequest) Creates a subscription definition.
CreateSubscriptionDefinitionVersionResult	createSubscriptionDefinitionVersion(CreateSubscriptionDefinitionVersionRequest createSubscriptionDefinitionVersionRequest) Creates a version of a subscription definition which has already been defined.
DeleteCoreDefinitionResult	deleteCoreDefinition(DeleteCoreDefinitionRequest deleteCoreDefinitionRequest) Deletes a core definition.
DeleteDeviceDefinitionResult	deleteDeviceDefinition(DeleteDeviceDefinitionRequest deleteDeviceDefinitionRequest) Deletes a device definition.
DeleteFunctionDefinitionResult	deleteFunctionDefinition(DeleteFunctionDefinitionRequest deleteFunctionDefinitionRequest) Deletes a Lambda function definition.
DeleteGroupResult	deleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes a group.
DeleteLoggerDefinitionResult	deleteLoggerDefinition(DeleteLoggerDefinitionRequest deleteLoggerDefinitionRequest) Deletes a logger definition.
DeleteSubscriptionDefinitionResult	deleteSubscriptionDefinition(DeleteSubscriptionDefinitionRequest deleteSubscriptionDefinitionRequest) Deletes a subscription definition.
DisassociateRoleFromGroupResult	disassociateRoleFromGroup(DisassociateRoleFromGroupRequest disassociateRoleFromGroupRequest) Disassociates the role from a group.
DisassociateServiceRoleFromAccountResult	disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest) Disassociates the service role from the account.
GetAssociatedRoleResult	getAssociatedRole(GetAssociatedRoleRequest getAssociatedRoleRequest) Retrieves the role associated with a particular group.
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.
GetConnectivityInfoResult	getConnectivityInfo(GetConnectivityInfoRequest getConnectivityInfoRequest) Retrieves the connectivity information for a core.
GetCoreDefinitionResult	getCoreDefinition(GetCoreDefinitionRequest getCoreDefinitionRequest) Retrieves information about a core definition version.
GetCoreDefinitionVersionResult	getCoreDefinitionVersion(GetCoreDefinitionVersionRequest getCoreDefinitionVersionRequest) Retrieves information about a core definition version.
GetDeploymentStatusResult	getDeploymentStatus(GetDeploymentStatusRequest getDeploymentStatusRequest) Returns the status of a deployment.
GetDeviceDefinitionResult	getDeviceDefinition(GetDeviceDefinitionRequest getDeviceDefinitionRequest) Retrieves information about a device definition.
GetDeviceDefinitionVersionResult	getDeviceDefinitionVersion(GetDeviceDefinitionVersionRequest getDeviceDefinitionVersionRequest) Retrieves information about a device definition version.
GetFunctionDefinitionResult	getFunctionDefinition(GetFunctionDefinitionRequest getFunctionDefinitionRequest) Retrieves information about a Lambda function definition, such as its creation time and latest version.
GetFunctionDefinitionVersionResult	getFunctionDefinitionVersion(GetFunctionDefinitionVersionRequest getFunctionDefinitionVersionRequest) Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.
GetGroupResult	getGroup(GetGroupRequest getGroupRequest) Retrieves information about a group.
GetGroupCertificateAuthorityResult	getGroupCertificateAuthority(GetGroupCertificateAuthorityRequest getGroupCertificateAuthorityRequest) Retreives the CA associated with a group.
GetGroupCertificateConfigurationResult	getGroupCertificateConfiguration(GetGroupCertificateConfigurationRequest getGroupCertificateConfigurationRequest) Retrieves the current configuration for the CA used by the group.
GetGroupVersionResult	getGroupVersion(GetGroupVersionRequest getGroupVersionRequest) Retrieves information about a group version.
GetLoggerDefinitionResult	getLoggerDefinition(GetLoggerDefinitionRequest getLoggerDefinitionRequest) Retrieves information about a logger definition.
GetLoggerDefinitionVersionResult	getLoggerDefinitionVersion(GetLoggerDefinitionVersionRequest getLoggerDefinitionVersionRequest) Retrieves information about a logger definition version.
GetServiceRoleForAccountResult	getServiceRoleForAccount(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest) Retrieves the service role that is attached to the account.
GetSubscriptionDefinitionResult	getSubscriptionDefinition(GetSubscriptionDefinitionRequest getSubscriptionDefinitionRequest) Retrieves information about a subscription definition.
GetSubscriptionDefinitionVersionResult	getSubscriptionDefinitionVersion(GetSubscriptionDefinitionVersionRequest getSubscriptionDefinitionVersionRequest) Retrieves information about a subscription definition version.
ListCoreDefinitionsResult	listCoreDefinitions(ListCoreDefinitionsRequest listCoreDefinitionsRequest) Retrieves a list of core definitions.
ListCoreDefinitionVersionsResult	listCoreDefinitionVersions(ListCoreDefinitionVersionsRequest listCoreDefinitionVersionsRequest) Lists versions of a core definition.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest listDeploymentsRequest) Returns a history of deployments for the group.
ListDeviceDefinitionsResult	listDeviceDefinitions(ListDeviceDefinitionsRequest listDeviceDefinitionsRequest) Retrieves a list of device definitions.
ListDeviceDefinitionVersionsResult	listDeviceDefinitionVersions(ListDeviceDefinitionVersionsRequest listDeviceDefinitionVersionsRequest) Lists the versions of a device definition.
ListFunctionDefinitionsResult	listFunctionDefinitions(ListFunctionDefinitionsRequest listFunctionDefinitionsRequest) Retrieves a list of Lambda function definitions.
ListFunctionDefinitionVersionsResult	listFunctionDefinitionVersions(ListFunctionDefinitionVersionsRequest listFunctionDefinitionVersionsRequest) Lists the versions of a Lambda function definition.
ListGroupCertificateAuthoritiesResult	listGroupCertificateAuthorities(ListGroupCertificateAuthoritiesRequest listGroupCertificateAuthoritiesRequest) Retrieves the current CAs for a group.
ListGroupsResult	listGroups(ListGroupsRequest listGroupsRequest) Retrieves a list of groups.
ListGroupVersionsResult	listGroupVersions(ListGroupVersionsRequest listGroupVersionsRequest) List the versions of a group.
ListLoggerDefinitionsResult	listLoggerDefinitions(ListLoggerDefinitionsRequest listLoggerDefinitionsRequest) Retrieves a list of logger definitions.
ListLoggerDefinitionVersionsResult	listLoggerDefinitionVersions(ListLoggerDefinitionVersionsRequest listLoggerDefinitionVersionsRequest) Lists the versions of a logger definition.
ListSubscriptionDefinitionsResult	listSubscriptionDefinitions(ListSubscriptionDefinitionsRequest listSubscriptionDefinitionsRequest) Retrieves a list of subscription definitions.
ListSubscriptionDefinitionVersionsResult	listSubscriptionDefinitionVersions(ListSubscriptionDefinitionVersionsRequest listSubscriptionDefinitionVersionsRequest) Lists the versions of a subscription definition.
ResetDeploymentsResult	resetDeployments(ResetDeploymentsRequest resetDeploymentsRequest) Resets a group's deployments.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateConnectivityInfoResult	updateConnectivityInfo(UpdateConnectivityInfoRequest updateConnectivityInfoRequest) Updates the connectivity information for the core.
UpdateCoreDefinitionResult	updateCoreDefinition(UpdateCoreDefinitionRequest updateCoreDefinitionRequest) Updates a core definition.
UpdateDeviceDefinitionResult	updateDeviceDefinition(UpdateDeviceDefinitionRequest updateDeviceDefinitionRequest) Updates a device definition.
UpdateFunctionDefinitionResult	updateFunctionDefinition(UpdateFunctionDefinitionRequest updateFunctionDefinitionRequest) Updates a Lambda function definition.
UpdateGroupResult	updateGroup(UpdateGroupRequest updateGroupRequest) Updates a group.
UpdateGroupCertificateConfigurationResult	updateGroupCertificateConfiguration(UpdateGroupCertificateConfigurationRequest updateGroupCertificateConfigurationRequest) Updates the Cert expiry time for a group.
UpdateLoggerDefinitionResult	updateLoggerDefinition(UpdateLoggerDefinitionRequest updateLoggerDefinitionRequest) Updates a logger definition.
UpdateSubscriptionDefinitionResult	updateSubscriptionDefinition(UpdateSubscriptionDefinitionRequest updateSubscriptionDefinitionRequest) Updates a subscription definition.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateRoleToGroup

AssociateRoleToGroupResult associateRoleToGroup(AssociateRoleToGroupRequest associateRoleToGroupRequest)

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

See Also:

AWS API Documentation

associateServiceRoleToAccount

AssociateServiceRoleToAccountResult associateServiceRoleToAccount(AssociateServiceRoleToAccountRequest associateServiceRoleToAccountRequest)

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

See Also:

AWS API Documentation

createCoreDefinition

CreateCoreDefinitionResult createCoreDefinition(CreateCoreDefinitionRequest createCoreDefinitionRequest)

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

See Also:

AWS API Documentation

createCoreDefinitionVersion

CreateCoreDefinitionVersionResult createCoreDefinitionVersion(CreateCoreDefinitionVersionRequest createCoreDefinitionVersionRequest)

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

See Also:

AWS API Documentation

createDeployment

CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

Creates a deployment.

Parameters:

createDeploymentRequest -

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

BadRequestException - This request was invalid.

See Also:

AWS API Documentation

createDeviceDefinition

CreateDeviceDefinitionResult createDeviceDefinition(CreateDeviceDefinitionRequest createDeviceDefinitionRequest)

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

See Also:

AWS API Documentation

createDeviceDefinitionVersion

CreateDeviceDefinitionVersionResult createDeviceDefinitionVersion(CreateDeviceDefinitionVersionRequest createDeviceDefinitionVersionRequest)

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

See Also:

AWS API Documentation

createFunctionDefinition

CreateFunctionDefinitionResult createFunctionDefinition(CreateFunctionDefinitionRequest createFunctionDefinitionRequest)

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

See Also:

AWS API Documentation

createFunctionDefinitionVersion

CreateFunctionDefinitionVersionResult createFunctionDefinitionVersion(CreateFunctionDefinitionVersionRequest createFunctionDefinitionVersionRequest)

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

See Also:

AWS API Documentation

createGroup

CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)

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

See Also:

AWS API Documentation

createGroupCertificateAuthority

CreateGroupCertificateAuthorityResult createGroupCertificateAuthority(CreateGroupCertificateAuthorityRequest createGroupCertificateAuthorityRequest)

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.

See Also:

AWS API Documentation

createGroupVersion

CreateGroupVersionResult createGroupVersion(CreateGroupVersionRequest createGroupVersionRequest)

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

See Also:

AWS API Documentation

createLoggerDefinition

CreateLoggerDefinitionResult createLoggerDefinition(CreateLoggerDefinitionRequest createLoggerDefinitionRequest)

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

See Also:

AWS API Documentation

createLoggerDefinitionVersion

CreateLoggerDefinitionVersionResult createLoggerDefinitionVersion(CreateLoggerDefinitionVersionRequest createLoggerDefinitionVersionRequest)

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

See Also:

AWS API Documentation

createSubscriptionDefinition

CreateSubscriptionDefinitionResult createSubscriptionDefinition(CreateSubscriptionDefinitionRequest createSubscriptionDefinitionRequest)

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

See Also:

AWS API Documentation

createSubscriptionDefinitionVersion

CreateSubscriptionDefinitionVersionResult createSubscriptionDefinitionVersion(CreateSubscriptionDefinitionVersionRequest createSubscriptionDefinitionVersionRequest)

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

See Also:

AWS API Documentation

deleteCoreDefinition

DeleteCoreDefinitionResult deleteCoreDefinition(DeleteCoreDefinitionRequest deleteCoreDefinitionRequest)

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

See Also:

AWS API Documentation

deleteDeviceDefinition

DeleteDeviceDefinitionResult deleteDeviceDefinition(DeleteDeviceDefinitionRequest deleteDeviceDefinitionRequest)

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

See Also:

AWS API Documentation

deleteFunctionDefinition

DeleteFunctionDefinitionResult deleteFunctionDefinition(DeleteFunctionDefinitionRequest deleteFunctionDefinitionRequest)

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

See Also:

AWS API Documentation

deleteGroup

DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)

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

See Also:

AWS API Documentation

deleteLoggerDefinition

DeleteLoggerDefinitionResult deleteLoggerDefinition(DeleteLoggerDefinitionRequest deleteLoggerDefinitionRequest)

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

See Also:

AWS API Documentation

deleteSubscriptionDefinition

DeleteSubscriptionDefinitionResult deleteSubscriptionDefinition(DeleteSubscriptionDefinitionRequest deleteSubscriptionDefinitionRequest)

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

See Also:

AWS API Documentation

disassociateRoleFromGroup

DisassociateRoleFromGroupResult disassociateRoleFromGroup(DisassociateRoleFromGroupRequest disassociateRoleFromGroupRequest)

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

See Also:

AWS API Documentation

disassociateServiceRoleFromAccount

DisassociateServiceRoleFromAccountResult disassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest disassociateServiceRoleFromAccountRequest)

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

See Also:

AWS API Documentation

getAssociatedRole

GetAssociatedRoleResult getAssociatedRole(GetAssociatedRoleRequest getAssociatedRoleRequest)

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

See Also:

AWS API Documentation

getConnectivityInfo

GetConnectivityInfoResult getConnectivityInfo(GetConnectivityInfoRequest getConnectivityInfoRequest)

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

See Also:

AWS API Documentation

getCoreDefinition

GetCoreDefinitionResult getCoreDefinition(GetCoreDefinitionRequest getCoreDefinitionRequest)

Retrieves information about a core definition version.

Parameters:

getCoreDefinitionRequest -

Returns:

Result of the GetCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getCoreDefinitionVersion

GetCoreDefinitionVersionResult getCoreDefinitionVersion(GetCoreDefinitionVersionRequest getCoreDefinitionVersionRequest)

Retrieves information about a core definition version.

Parameters:

getCoreDefinitionVersionRequest -

Returns:

Result of the GetCoreDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getDeploymentStatus

GetDeploymentStatusResult getDeploymentStatus(GetDeploymentStatusRequest getDeploymentStatusRequest)

Returns the status of a deployment.

Parameters:

getDeploymentStatusRequest -

Returns:

Result of the GetDeploymentStatus operation returned by the service.

Throws:

BadRequestException - This request was invalid.

See Also:

AWS API Documentation

getDeviceDefinition

GetDeviceDefinitionResult getDeviceDefinition(GetDeviceDefinitionRequest getDeviceDefinitionRequest)

Retrieves information about a device definition.

Parameters:

getDeviceDefinitionRequest -

Returns:

Result of the GetDeviceDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getDeviceDefinitionVersion

GetDeviceDefinitionVersionResult getDeviceDefinitionVersion(GetDeviceDefinitionVersionRequest getDeviceDefinitionVersionRequest)

Retrieves information about a device definition version.

Parameters:

getDeviceDefinitionVersionRequest -

Returns:

Result of the GetDeviceDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getFunctionDefinition

GetFunctionDefinitionResult getFunctionDefinition(GetFunctionDefinitionRequest getFunctionDefinitionRequest)

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

See Also:

AWS API Documentation

getFunctionDefinitionVersion

GetFunctionDefinitionVersionResult getFunctionDefinitionVersion(GetFunctionDefinitionVersionRequest getFunctionDefinitionVersionRequest)

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

See Also:

AWS API Documentation

getGroup

GetGroupResult getGroup(GetGroupRequest getGroupRequest)

Retrieves information about a group.

Parameters:

getGroupRequest -

Returns:

Result of the GetGroup operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getGroupCertificateAuthority

GetGroupCertificateAuthorityResult getGroupCertificateAuthority(GetGroupCertificateAuthorityRequest getGroupCertificateAuthorityRequest)

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.

See Also:

AWS API Documentation

getGroupCertificateConfiguration

GetGroupCertificateConfigurationResult getGroupCertificateConfiguration(GetGroupCertificateConfigurationRequest getGroupCertificateConfigurationRequest)

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.

See Also:

AWS API Documentation

getGroupVersion

GetGroupVersionResult getGroupVersion(GetGroupVersionRequest getGroupVersionRequest)

Retrieves information about a group version.

Parameters:

getGroupVersionRequest -

Returns:

Result of the GetGroupVersion operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getLoggerDefinition

GetLoggerDefinitionResult getLoggerDefinition(GetLoggerDefinitionRequest getLoggerDefinitionRequest)

Retrieves information about a logger definition.

Parameters:

getLoggerDefinitionRequest -

Returns:

Result of the GetLoggerDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getLoggerDefinitionVersion

GetLoggerDefinitionVersionResult getLoggerDefinitionVersion(GetLoggerDefinitionVersionRequest getLoggerDefinitionVersionRequest)

Retrieves information about a logger definition version.

Parameters:

getLoggerDefinitionVersionRequest -

Returns:

Result of the GetLoggerDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getServiceRoleForAccount

GetServiceRoleForAccountResult getServiceRoleForAccount(GetServiceRoleForAccountRequest getServiceRoleForAccountRequest)

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

See Also:

AWS API Documentation

getSubscriptionDefinition

GetSubscriptionDefinitionResult getSubscriptionDefinition(GetSubscriptionDefinitionRequest getSubscriptionDefinitionRequest)

Retrieves information about a subscription definition.

Parameters:

getSubscriptionDefinitionRequest -

Returns:

Result of the GetSubscriptionDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

getSubscriptionDefinitionVersion

GetSubscriptionDefinitionVersionResult getSubscriptionDefinitionVersion(GetSubscriptionDefinitionVersionRequest getSubscriptionDefinitionVersionRequest)

Retrieves information about a subscription definition version.

Parameters:

getSubscriptionDefinitionVersionRequest -

Returns:

Result of the GetSubscriptionDefinitionVersion operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listCoreDefinitionVersions

ListCoreDefinitionVersionsResult listCoreDefinitionVersions(ListCoreDefinitionVersionsRequest listCoreDefinitionVersionsRequest)

Lists versions of a core definition.

Parameters:

listCoreDefinitionVersionsRequest -

Returns:

Result of the ListCoreDefinitionVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listCoreDefinitions

ListCoreDefinitionsResult listCoreDefinitions(ListCoreDefinitionsRequest listCoreDefinitionsRequest)

Retrieves a list of core definitions.

Parameters:

listCoreDefinitionsRequest -

Returns:

Result of the ListCoreDefinitions operation returned by the service.

See Also:

AWS API Documentation

listDeployments

ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)

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.

See Also:

AWS API Documentation

listDeviceDefinitionVersions

ListDeviceDefinitionVersionsResult listDeviceDefinitionVersions(ListDeviceDefinitionVersionsRequest listDeviceDefinitionVersionsRequest)

Lists the versions of a device definition.

Parameters:

listDeviceDefinitionVersionsRequest -

Returns:

Result of the ListDeviceDefinitionVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listDeviceDefinitions

ListDeviceDefinitionsResult listDeviceDefinitions(ListDeviceDefinitionsRequest listDeviceDefinitionsRequest)

Retrieves a list of device definitions.

Parameters:

listDeviceDefinitionsRequest -

Returns:

Result of the ListDeviceDefinitions operation returned by the service.

See Also:

AWS API Documentation

listFunctionDefinitionVersions

ListFunctionDefinitionVersionsResult listFunctionDefinitionVersions(ListFunctionDefinitionVersionsRequest listFunctionDefinitionVersionsRequest)

Lists the versions of a Lambda function definition.

Parameters:

listFunctionDefinitionVersionsRequest -

Returns:

Result of the ListFunctionDefinitionVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listFunctionDefinitions

ListFunctionDefinitionsResult listFunctionDefinitions(ListFunctionDefinitionsRequest listFunctionDefinitionsRequest)

Retrieves a list of Lambda function definitions.

Parameters:

listFunctionDefinitionsRequest -

Returns:

Result of the ListFunctionDefinitions operation returned by the service.

See Also:

AWS API Documentation

listGroupCertificateAuthorities

ListGroupCertificateAuthoritiesResult listGroupCertificateAuthorities(ListGroupCertificateAuthoritiesRequest listGroupCertificateAuthoritiesRequest)

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.

See Also:

AWS API Documentation

listGroupVersions

ListGroupVersionsResult listGroupVersions(ListGroupVersionsRequest listGroupVersionsRequest)

List the versions of a group.

Parameters:

listGroupVersionsRequest -

Returns:

Result of the ListGroupVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listGroups

ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)

Retrieves a list of groups.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listLoggerDefinitionVersions

ListLoggerDefinitionVersionsResult listLoggerDefinitionVersions(ListLoggerDefinitionVersionsRequest listLoggerDefinitionVersionsRequest)

Lists the versions of a logger definition.

Parameters:

listLoggerDefinitionVersionsRequest -

Returns:

Result of the ListLoggerDefinitionVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listLoggerDefinitions

ListLoggerDefinitionsResult listLoggerDefinitions(ListLoggerDefinitionsRequest listLoggerDefinitionsRequest)

Retrieves a list of logger definitions.

Parameters:

listLoggerDefinitionsRequest -

Returns:

Result of the ListLoggerDefinitions operation returned by the service.

See Also:

AWS API Documentation

listSubscriptionDefinitionVersions

ListSubscriptionDefinitionVersionsResult listSubscriptionDefinitionVersions(ListSubscriptionDefinitionVersionsRequest listSubscriptionDefinitionVersionsRequest)

Lists the versions of a subscription definition.

Parameters:

listSubscriptionDefinitionVersionsRequest -

Returns:

Result of the ListSubscriptionDefinitionVersions operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

listSubscriptionDefinitions

ListSubscriptionDefinitionsResult listSubscriptionDefinitions(ListSubscriptionDefinitionsRequest listSubscriptionDefinitionsRequest)

Retrieves a list of subscription definitions.

Parameters:

listSubscriptionDefinitionsRequest -

Returns:

Result of the ListSubscriptionDefinitions operation returned by the service.

See Also:

AWS API Documentation

resetDeployments

ResetDeploymentsResult resetDeployments(ResetDeploymentsRequest resetDeploymentsRequest)

Resets a group's deployments.

Parameters:

resetDeploymentsRequest - Information needed to perform a reset of a group's deployments.

Returns:

Result of the ResetDeployments operation returned by the service.

Throws:

BadRequestException - invalid request

See Also:

AWS API Documentation

updateConnectivityInfo

UpdateConnectivityInfoResult updateConnectivityInfo(UpdateConnectivityInfoRequest updateConnectivityInfoRequest)

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

See Also:

AWS API Documentation

updateCoreDefinition

UpdateCoreDefinitionResult updateCoreDefinition(UpdateCoreDefinitionRequest updateCoreDefinitionRequest)

Updates a core definition.

Parameters:

updateCoreDefinitionRequest -

Returns:

Result of the UpdateCoreDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

updateDeviceDefinition

UpdateDeviceDefinitionResult updateDeviceDefinition(UpdateDeviceDefinitionRequest updateDeviceDefinitionRequest)

Updates a device definition.

Parameters:

updateDeviceDefinitionRequest -

Returns:

Result of the UpdateDeviceDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

updateFunctionDefinition

UpdateFunctionDefinitionResult updateFunctionDefinition(UpdateFunctionDefinitionRequest updateFunctionDefinitionRequest)

Updates a Lambda function definition.

Parameters:

updateFunctionDefinitionRequest -

Returns:

Result of the UpdateFunctionDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

updateGroup

UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)

Updates a group.

Parameters:

updateGroupRequest -

Returns:

Result of the UpdateGroup operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

updateGroupCertificateConfiguration

UpdateGroupCertificateConfigurationResult updateGroupCertificateConfiguration(UpdateGroupCertificateConfigurationRequest updateGroupCertificateConfigurationRequest)

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.

See Also:

AWS API Documentation

updateLoggerDefinition

UpdateLoggerDefinitionResult updateLoggerDefinition(UpdateLoggerDefinitionRequest updateLoggerDefinitionRequest)

Updates a logger definition.

Parameters:

updateLoggerDefinitionRequest -

Returns:

Result of the UpdateLoggerDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

updateSubscriptionDefinition

UpdateSubscriptionDefinitionResult updateSubscriptionDefinition(UpdateSubscriptionDefinitionRequest updateSubscriptionDefinitionRequest)

Updates a subscription definition.

Parameters:

updateSubscriptionDefinitionRequest -

Returns:

Result of the UpdateSubscriptionDefinition operation returned by the service.

Throws:

BadRequestException - user error

See Also:

AWS API Documentation

shutdown

void shutdown()

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

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Parameters:

request - The originally executed request.

Returns:

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