AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AssociateRoleToGroupRequest

Container for the parameters to the AssociateRoleToGroup operation. 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.

Class AssociateRoleToGroupResponse

This is the response object from the AssociateRoleToGroup operation.

Class AssociateServiceRoleToAccountRequest

Container for the parameters to the AssociateServiceRoleToAccount operation. 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``

Class AssociateServiceRoleToAccountResponse

This is the response object from the AssociateServiceRoleToAccount operation.

Class BadRequestException

Greengrass exception

Class ConnectivityInfo

Connectivity Info

Class Core

Information on the core

Class CoreDefinitionVersion

Information on core definition version

Class CreateCoreDefinitionRequest

Container for the parameters to the CreateCoreDefinition operation. 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.

Class CreateCoreDefinitionResponse

This is the response object from the CreateCoreDefinition operation.

Class CreateCoreDefinitionVersionRequest

Container for the parameters to the CreateCoreDefinitionVersion operation. Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Class CreateCoreDefinitionVersionResponse

This is the response object from the CreateCoreDefinitionVersion operation.

Class CreateDeploymentRequest

Container for the parameters to the CreateDeployment operation. Creates a deployment.

Class CreateDeploymentResponse

This is the response object from the CreateDeployment operation.

Class CreateDeviceDefinitionRequest

Container for the parameters to the CreateDeviceDefinition operation. Creates a device definition. You may optinally provide the initial version of the device definition or use ``CreateDeviceDefinitionVersion`` at a later time.

Class CreateDeviceDefinitionResponse

This is the response object from the CreateDeviceDefinition operation.

Class CreateDeviceDefinitionVersionRequest

Container for the parameters to the CreateDeviceDefinitionVersion operation. Creates a version of a device definition that has already been defined.

Class CreateDeviceDefinitionVersionResponse

This is the response object from the CreateDeviceDefinitionVersion operation.

Class CreateFunctionDefinitionRequest

Container for the parameters to the CreateFunctionDefinition operation. 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.

Class CreateFunctionDefinitionResponse

This is the response object from the CreateFunctionDefinition operation.

Class CreateFunctionDefinitionVersionRequest

Container for the parameters to the CreateFunctionDefinitionVersion operation. Create a version of a Lambda function definition that has already been defined.

Class CreateFunctionDefinitionVersionResponse

This is the response object from the CreateFunctionDefinitionVersion operation.

Class CreateGroupCertificateAuthorityRequest

Container for the parameters to the CreateGroupCertificateAuthority operation. Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Class CreateGroupCertificateAuthorityResponse

This is the response object from the CreateGroupCertificateAuthority operation.

Class CreateGroupRequest

Container for the parameters to the CreateGroup operation. Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.

Class CreateGroupResponse

This is the response object from the CreateGroup operation.

Class CreateGroupVersionRequest

Container for the parameters to the CreateGroupVersion operation. Creates a version of a group which has already been defined.

Class CreateGroupVersionResponse

This is the response object from the CreateGroupVersion operation.

Class CreateLoggerDefinitionRequest

Container for the parameters to the CreateLoggerDefinition operation. Creates a logger definition. You may optionally provide the initial version of the logger definition or use ``CreateLoggerDefinitionVersion`` at a later time.

Class CreateLoggerDefinitionResponse

This is the response object from the CreateLoggerDefinition operation.

Class CreateLoggerDefinitionVersionRequest

Container for the parameters to the CreateLoggerDefinitionVersion operation. Creates a version of a logger definition that has already been defined.

Class CreateLoggerDefinitionVersionResponse

This is the response object from the CreateLoggerDefinitionVersion operation.

Class CreateSubscriptionDefinitionRequest

Container for the parameters to the CreateSubscriptionDefinition operation. Creates a subscription definition. You may optionally provide the initial version of the subscription definition or use ``CreateSubscriptionDefinitionVersion`` at a later time.

Class CreateSubscriptionDefinitionResponse

This is the response object from the CreateSubscriptionDefinition operation.

Class CreateSubscriptionDefinitionVersionRequest

Container for the parameters to the CreateSubscriptionDefinitionVersion operation. Creates a version of a subscription definition which has already been defined.

Class CreateSubscriptionDefinitionVersionResponse

This is the response object from the CreateSubscriptionDefinitionVersion operation.

Class DefinitionInformation

Information on the Definition

Class DeleteCoreDefinitionRequest

Container for the parameters to the DeleteCoreDefinition operation. Deletes a core definition. The core definition must not have been used in a deployment.

Class DeleteCoreDefinitionResponse

This is the response object from the DeleteCoreDefinition operation.

Class DeleteDeviceDefinitionRequest

Container for the parameters to the DeleteDeviceDefinition operation. Deletes a device definition. The device definition must not have been used in a deployment.

Class DeleteDeviceDefinitionResponse

This is the response object from the DeleteDeviceDefinition operation.

Class DeleteFunctionDefinitionRequest

Container for the parameters to the DeleteFunctionDefinition operation. Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.

Class DeleteFunctionDefinitionResponse

This is the response object from the DeleteFunctionDefinition operation.

Class DeleteGroupRequest

Container for the parameters to the DeleteGroup operation. Deletes a group. The group must not have been used in deployment.

Class DeleteGroupResponse

This is the response object from the DeleteGroup operation.

Class DeleteLoggerDefinitionRequest

Container for the parameters to the DeleteLoggerDefinition operation. Deletes a logger definition. The logger definition must not have been used in a deployment.

Class DeleteLoggerDefinitionResponse

This is the response object from the DeleteLoggerDefinition operation.

Class DeleteSubscriptionDefinitionRequest

Container for the parameters to the DeleteSubscriptionDefinition operation. Deletes a subscription definition. The subscription definition must not have been used in a deployment.

Class DeleteSubscriptionDefinitionResponse

This is the response object from the DeleteSubscriptionDefinition operation.

Class Deployment

Information on the deployment

Class Device

Information on a Device

Class DeviceDefinitionVersion

Information on device definition version

Class DisassociateRoleFromGroupRequest

Container for the parameters to the DisassociateRoleFromGroup operation. Disassociates the role from a group.

Class DisassociateRoleFromGroupResponse

This is the response object from the DisassociateRoleFromGroup operation.

Class DisassociateServiceRoleFromAccountRequest

Container for the parameters to the DisassociateServiceRoleFromAccount operation. Disassociates the service role from the account. Without a service role, deployments will not work.

Class DisassociateServiceRoleFromAccountResponse

This is the response object from the DisassociateServiceRoleFromAccount operation.

Class ErrorDetail

ErrorDetail

Class Function

Information on function

Class FunctionConfiguration

Configuration of the function

Class FunctionConfigurationEnvironment

Environment of the function configuration

Class FunctionDefinitionVersion

Information on the function definition version

Class GetAssociatedRoleRequest

Container for the parameters to the GetAssociatedRole operation. Retrieves the role associated with a particular group.

Class GetAssociatedRoleResponse

This is the response object from the GetAssociatedRole operation.

Class GetConnectivityInfoRequest

Container for the parameters to the GetConnectivityInfo operation. Retrieves the connectivity information for a core.

Class GetConnectivityInfoResponse

This is the response object from the GetConnectivityInfo operation.

Class GetCoreDefinitionRequest

Container for the parameters to the GetCoreDefinition operation. Retrieves information about a core definition version.

Class GetCoreDefinitionResponse

This is the response object from the GetCoreDefinition operation.

Class GetCoreDefinitionVersionRequest

Container for the parameters to the GetCoreDefinitionVersion operation. Retrieves information about a core definition version.

Class GetCoreDefinitionVersionResponse

This is the response object from the GetCoreDefinitionVersion operation.

Class GetDeploymentStatusRequest

Container for the parameters to the GetDeploymentStatus operation. Returns the status of a deployment.

Class GetDeploymentStatusResponse

This is the response object from the GetDeploymentStatus operation.

Class GetDeviceDefinitionRequest

Container for the parameters to the GetDeviceDefinition operation. Retrieves information about a device definition.

Class GetDeviceDefinitionResponse

This is the response object from the GetDeviceDefinition operation.

Class GetDeviceDefinitionVersionRequest

Container for the parameters to the GetDeviceDefinitionVersion operation. Retrieves information about a device definition version.

Class GetDeviceDefinitionVersionResponse

This is the response object from the GetDeviceDefinitionVersion operation.

Class GetFunctionDefinitionRequest

Container for the parameters to the GetFunctionDefinition operation. Retrieves information about a Lambda function definition, such as its creation time and latest version.

Class GetFunctionDefinitionResponse

This is the response object from the GetFunctionDefinition operation.

Class GetFunctionDefinitionVersionRequest

Container for the parameters to the GetFunctionDefinitionVersion operation. Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.

Class GetFunctionDefinitionVersionResponse

This is the response object from the GetFunctionDefinitionVersion operation.

Class GetGroupCertificateAuthorityRequest

Container for the parameters to the GetGroupCertificateAuthority operation. Retreives the CA associated with a group. Returns the public key of the CA.

Class GetGroupCertificateAuthorityResponse

This is the response object from the GetGroupCertificateAuthority operation.

Class GetGroupCertificateConfigurationRequest

Container for the parameters to the GetGroupCertificateConfiguration operation. Retrieves the current configuration for the CA used by the group.

Class GetGroupCertificateConfigurationResponse

This is the response object from the GetGroupCertificateConfiguration operation.

Class GetGroupRequest

Container for the parameters to the GetGroup operation. Retrieves information about a group.

Class GetGroupResponse

This is the response object from the GetGroup operation.

Class GetGroupVersionRequest

Container for the parameters to the GetGroupVersion operation. Retrieves information about a group version.

Class GetGroupVersionResponse

This is the response object from the GetGroupVersion operation.

Class GetLoggerDefinitionRequest

Container for the parameters to the GetLoggerDefinition operation. Retrieves information about a logger definition.

Class GetLoggerDefinitionResponse

This is the response object from the GetLoggerDefinition operation.

Class GetLoggerDefinitionVersionRequest

Container for the parameters to the GetLoggerDefinitionVersion operation. Retrieves information about a logger definition version.

Class GetLoggerDefinitionVersionResponse

This is the response object from the GetLoggerDefinitionVersion operation.

Class GetServiceRoleForAccountRequest

Container for the parameters to the GetServiceRoleForAccount operation. Retrieves the service role that is attached to the account.

Class GetServiceRoleForAccountResponse

This is the response object from the GetServiceRoleForAccount operation.

Class GetSubscriptionDefinitionRequest

Container for the parameters to the GetSubscriptionDefinition operation. Retrieves information about a subscription definition.

Class GetSubscriptionDefinitionResponse

This is the response object from the GetSubscriptionDefinition operation.

Class GetSubscriptionDefinitionVersionRequest

Container for the parameters to the GetSubscriptionDefinitionVersion operation. Retrieves information about a subscription definition version.

Class GetSubscriptionDefinitionVersionResponse

This is the response object from the GetSubscriptionDefinitionVersion operation.

Class GroupCertificateAuthorityProperties

Information on group certificate authority properties

Class GroupInformation

Information on the group

Class GroupVersion

Information on group version

Class InternalServerErrorException

Greengrass exception

Class ListCoreDefinitionsRequest

Container for the parameters to the ListCoreDefinitions operation. Retrieves a list of core definitions.

Class ListCoreDefinitionsResponse

This is the response object from the ListCoreDefinitions operation.

Class ListCoreDefinitionVersionsRequest

Container for the parameters to the ListCoreDefinitionVersions operation. Lists versions of a core definition.

Class ListCoreDefinitionVersionsResponse

This is the response object from the ListCoreDefinitionVersions operation.

Class ListDeploymentsRequest

Container for the parameters to the ListDeployments operation. Returns a history of deployments for the group.

Class ListDeploymentsResponse

This is the response object from the ListDeployments operation.

Class ListDeviceDefinitionsRequest

Container for the parameters to the ListDeviceDefinitions operation. Retrieves a list of device definitions.

Class ListDeviceDefinitionsResponse

This is the response object from the ListDeviceDefinitions operation.

Class ListDeviceDefinitionVersionsRequest

Container for the parameters to the ListDeviceDefinitionVersions operation. Lists the versions of a device definition.

Class ListDeviceDefinitionVersionsResponse

This is the response object from the ListDeviceDefinitionVersions operation.

Class ListFunctionDefinitionsRequest

Container for the parameters to the ListFunctionDefinitions operation. Retrieves a list of Lambda function definitions.

Class ListFunctionDefinitionsResponse

This is the response object from the ListFunctionDefinitions operation.

Class ListFunctionDefinitionVersionsRequest

Container for the parameters to the ListFunctionDefinitionVersions operation. Lists the versions of a Lambda function definition.

Class ListFunctionDefinitionVersionsResponse

This is the response object from the ListFunctionDefinitionVersions operation.

Class ListGroupCertificateAuthoritiesRequest

Container for the parameters to the ListGroupCertificateAuthorities operation. Retrieves the current CAs for a group.

Class ListGroupCertificateAuthoritiesResponse

This is the response object from the ListGroupCertificateAuthorities operation.

Class ListGroupsRequest

Container for the parameters to the ListGroups operation. Retrieves a list of groups.

Class ListGroupsResponse

This is the response object from the ListGroups operation.

Class ListGroupVersionsRequest

Container for the parameters to the ListGroupVersions operation. List the versions of a group.

Class ListGroupVersionsResponse

This is the response object from the ListGroupVersions operation.

Class ListLoggerDefinitionsRequest

Container for the parameters to the ListLoggerDefinitions operation. Retrieves a list of logger definitions.

Class ListLoggerDefinitionsResponse

This is the response object from the ListLoggerDefinitions operation.

Class ListLoggerDefinitionVersionsRequest

Container for the parameters to the ListLoggerDefinitionVersions operation. Lists the versions of a logger definition.

Class ListLoggerDefinitionVersionsResponse

This is the response object from the ListLoggerDefinitionVersions operation.

Class ListSubscriptionDefinitionsRequest

Container for the parameters to the ListSubscriptionDefinitions operation. Retrieves a list of subscription definitions.

Class ListSubscriptionDefinitionsResponse

This is the response object from the ListSubscriptionDefinitions operation.

Class ListSubscriptionDefinitionVersionsRequest

Container for the parameters to the ListSubscriptionDefinitionVersions operation. Lists the versions of a subscription definition.

Class ListSubscriptionDefinitionVersionsResponse

This is the response object from the ListSubscriptionDefinitionVersions operation.

Class Logger

Information on the Logger

Class LoggerDefinitionVersion

Information on logger definition version

Class ResetDeploymentsRequest

Container for the parameters to the ResetDeployments operation. Resets a group's deployments.

Class ResetDeploymentsResponse

This is the response object from the ResetDeployments operation.

Class Subscription

Information on subscription

Class SubscriptionDefinitionVersion

Information on subscription definition version

Class UpdateConnectivityInfoRequest

Container for the parameters to the UpdateConnectivityInfo operation. 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.

Class UpdateConnectivityInfoResponse

This is the response object from the UpdateConnectivityInfo operation.

Class UpdateCoreDefinitionRequest

Container for the parameters to the UpdateCoreDefinition operation. Updates a core definition.

Class UpdateCoreDefinitionResponse

This is the response object from the UpdateCoreDefinition operation.

Class UpdateDeviceDefinitionRequest

Container for the parameters to the UpdateDeviceDefinition operation. Updates a device definition.

Class UpdateDeviceDefinitionResponse

This is the response object from the UpdateDeviceDefinition operation.

Class UpdateFunctionDefinitionRequest

Container for the parameters to the UpdateFunctionDefinition operation. Updates a Lambda function definition.

Class UpdateFunctionDefinitionResponse

This is the response object from the UpdateFunctionDefinition operation.

Class UpdateGroupCertificateConfigurationRequest

Container for the parameters to the UpdateGroupCertificateConfiguration operation. Updates the Cert expiry time for a group.

Class UpdateGroupCertificateConfigurationResponse

This is the response object from the UpdateGroupCertificateConfiguration operation.

Class UpdateGroupRequest

Container for the parameters to the UpdateGroup operation. Updates a group.

Class UpdateGroupResponse

This is the response object from the UpdateGroup operation.

Class UpdateLoggerDefinitionRequest

Container for the parameters to the UpdateLoggerDefinition operation. Updates a logger definition.

Class UpdateLoggerDefinitionResponse

This is the response object from the UpdateLoggerDefinition operation.

Class UpdateSubscriptionDefinitionRequest

Container for the parameters to the UpdateSubscriptionDefinition operation. Updates a subscription definition.

Class UpdateSubscriptionDefinitionResponse

This is the response object from the UpdateSubscriptionDefinition operation.

Class VersionInformation

Information on the version