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.

Implementation for accessing Greengrass

AWS IoT 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 IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Greengrass.AmazonGreengrassClient

Namespace: Amazon.Greengrass
Assembly: AWSSDK.Greengrass.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonGreengrassClient : AmazonServiceClient
         IAmazonGreengrass, IAmazonService, IDisposable

The AmazonGreengrassClient type exposes the following members

Constructors

NameDescription
Public Method AmazonGreengrassClient()

Constructs AmazonGreengrassClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonGreengrassClient(RegionEndpoint)

Constructs AmazonGreengrassClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonGreengrassClient(AmazonGreengrassConfig)

Constructs AmazonGreengrassClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonGreengrassClient(AWSCredentials)

Constructs AmazonGreengrassClient with AWS Credentials

Public Method AmazonGreengrassClient(AWSCredentials, RegionEndpoint)

Constructs AmazonGreengrassClient with AWS Credentials

Public Method AmazonGreengrassClient(AWSCredentials, AmazonGreengrassConfig)

Constructs AmazonGreengrassClient with AWS Credentials and an AmazonGreengrassClient Configuration object.

Public Method AmazonGreengrassClient(string, string)

Constructs AmazonGreengrassClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonGreengrassClient(string, string, RegionEndpoint)

Constructs AmazonGreengrassClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonGreengrassClient(string, string, AmazonGreengrassConfig)

Constructs AmazonGreengrassClient with AWS Access Key ID, AWS Secret Key and an AmazonGreengrassClient Configuration object.

Public Method AmazonGreengrassClient(string, string, string)

Constructs AmazonGreengrassClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonGreengrassClient(string, string, string, RegionEndpoint)

Constructs AmazonGreengrassClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonGreengrassClient(string, string, string, AmazonGreengrassConfig)

Constructs AmazonGreengrassClient with AWS Access Key ID, AWS Secret Key and an AmazonGreengrassClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateRoleToGroup(AssociateRoleToGroupRequest)

Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

Public Method AssociateRoleToGroupAsync(AssociateRoleToGroupRequest, CancellationToken)

Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

Public Method AssociateServiceRoleToAccount(AssociateServiceRoleToAccountRequest)

Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

Public Method AssociateServiceRoleToAccountAsync(AssociateServiceRoleToAccountRequest, CancellationToken)

Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

Public Method CreateConnectorDefinition(CreateConnectorDefinitionRequest)

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

Public Method CreateConnectorDefinitionAsync(CreateConnectorDefinitionRequest, CancellationToken)

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

Public Method CreateConnectorDefinitionVersion(CreateConnectorDefinitionVersionRequest)

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

Public Method CreateConnectorDefinitionVersionAsync(CreateConnectorDefinitionVersionRequest, CancellationToken)

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

Public Method CreateCoreDefinition(CreateCoreDefinitionRequest)

Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

Public Method CreateCoreDefinitionAsync(CreateCoreDefinitionRequest, CancellationToken)

Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

Public Method CreateCoreDefinitionVersion(CreateCoreDefinitionVersionRequest)

Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.

Public Method CreateCoreDefinitionVersionAsync(CreateCoreDefinitionVersionRequest, CancellationToken)

Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.

Public Method CreateDeployment(CreateDeploymentRequest)

Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Public Method CreateDeviceDefinition(CreateDeviceDefinitionRequest)

Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.

Public Method CreateDeviceDefinitionAsync(CreateDeviceDefinitionRequest, CancellationToken)

Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.

Public Method CreateDeviceDefinitionVersion(CreateDeviceDefinitionVersionRequest)

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

Public Method CreateDeviceDefinitionVersionAsync(CreateDeviceDefinitionVersionRequest, CancellationToken)

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

Public Method CreateFunctionDefinition(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.

Public Method CreateFunctionDefinitionAsync(CreateFunctionDefinitionRequest, CancellationToken)

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.

Public Method CreateFunctionDefinitionVersion(CreateFunctionDefinitionVersionRequest)

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

Public Method CreateFunctionDefinitionVersionAsync(CreateFunctionDefinitionVersionRequest, CancellationToken)

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

Public Method CreateGroup(CreateGroupRequest)

Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

Public Method CreateGroupCertificateAuthority(CreateGroupCertificateAuthorityRequest)

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

Public Method CreateGroupCertificateAuthorityAsync(CreateGroupCertificateAuthorityRequest, CancellationToken)

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

Public Method CreateGroupVersion(CreateGroupVersionRequest)

Creates a version of a group which has already been defined.

Public Method CreateGroupVersionAsync(CreateGroupVersionRequest, CancellationToken)

Creates a version of a group which has already been defined.

Public Method CreateLoggerDefinition(CreateLoggerDefinitionRequest)

Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.

Public Method CreateLoggerDefinitionAsync(CreateLoggerDefinitionRequest, CancellationToken)

Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.

Public Method CreateLoggerDefinitionVersion(CreateLoggerDefinitionVersionRequest)

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

Public Method CreateLoggerDefinitionVersionAsync(CreateLoggerDefinitionVersionRequest, CancellationToken)

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

Public Method CreateResourceDefinition(CreateResourceDefinitionRequest)

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later.

Public Method CreateResourceDefinitionAsync(CreateResourceDefinitionRequest, CancellationToken)

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later.

Public Method CreateResourceDefinitionVersion(CreateResourceDefinitionVersionRequest)

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

Public Method CreateResourceDefinitionVersionAsync(CreateResourceDefinitionVersionRequest, CancellationToken)

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

Public Method CreateSoftwareUpdateJob(CreateSoftwareUpdateJobRequest)

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Public Method CreateSoftwareUpdateJobAsync(CreateSoftwareUpdateJobRequest, CancellationToken)

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Public Method CreateSubscriptionDefinition(CreateSubscriptionDefinitionRequest)

Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.

Public Method CreateSubscriptionDefinitionAsync(CreateSubscriptionDefinitionRequest, CancellationToken)

Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.

Public Method CreateSubscriptionDefinitionVersion(CreateSubscriptionDefinitionVersionRequest)

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

Public Method CreateSubscriptionDefinitionVersionAsync(CreateSubscriptionDefinitionVersionRequest, CancellationToken)

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

Public Method DeleteConnectorDefinition(DeleteConnectorDefinitionRequest)

Deletes a connector definition.

Public Method DeleteConnectorDefinitionAsync(DeleteConnectorDefinitionRequest, CancellationToken)

Deletes a connector definition.

Public Method DeleteCoreDefinition(DeleteCoreDefinitionRequest)

Deletes a core definition.

Public Method DeleteCoreDefinitionAsync(DeleteCoreDefinitionRequest, CancellationToken)

Deletes a core definition.

Public Method DeleteDeviceDefinition(DeleteDeviceDefinitionRequest)

Deletes a device definition.

Public Method DeleteDeviceDefinitionAsync(DeleteDeviceDefinitionRequest, CancellationToken)

Deletes a device definition.

Public Method DeleteFunctionDefinition(DeleteFunctionDefinitionRequest)

Deletes a Lambda function definition.

Public Method DeleteFunctionDefinitionAsync(DeleteFunctionDefinitionRequest, CancellationToken)

Deletes a Lambda function definition.

Public Method DeleteGroup(DeleteGroupRequest)

Deletes a group.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Deletes a group.

Public Method DeleteLoggerDefinition(DeleteLoggerDefinitionRequest)

Deletes a logger definition.

Public Method DeleteLoggerDefinitionAsync(DeleteLoggerDefinitionRequest, CancellationToken)

Deletes a logger definition.

Public Method DeleteResourceDefinition(DeleteResourceDefinitionRequest)

Deletes a resource definition.

Public Method DeleteResourceDefinitionAsync(DeleteResourceDefinitionRequest, CancellationToken)

Deletes a resource definition.

Public Method DeleteSubscriptionDefinition(DeleteSubscriptionDefinitionRequest)

Deletes a subscription definition.

Public Method DeleteSubscriptionDefinitionAsync(DeleteSubscriptionDefinitionRequest, CancellationToken)

Deletes a subscription definition.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateRoleFromGroup(DisassociateRoleFromGroupRequest)

Disassociates the role from a group.

Public Method DisassociateRoleFromGroupAsync(DisassociateRoleFromGroupRequest, CancellationToken)

Disassociates the role from a group.

Public Method DisassociateServiceRoleFromAccount(DisassociateServiceRoleFromAccountRequest)

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

Public Method DisassociateServiceRoleFromAccountAsync(DisassociateServiceRoleFromAccountRequest, CancellationToken)

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

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAssociatedRole(GetAssociatedRoleRequest)

Retrieves the role associated with a particular group.

Public Method GetAssociatedRoleAsync(GetAssociatedRoleRequest, CancellationToken)

Retrieves the role associated with a particular group.

Public Method GetBulkDeploymentStatus(GetBulkDeploymentStatusRequest)

Returns the status of a bulk deployment.

Public Method GetBulkDeploymentStatusAsync(GetBulkDeploymentStatusRequest, CancellationToken)

Returns the status of a bulk deployment.

Public Method GetConnectivityInfo(GetConnectivityInfoRequest)

Retrieves the connectivity information for a core.

Public Method GetConnectivityInfoAsync(GetConnectivityInfoRequest, CancellationToken)

Retrieves the connectivity information for a core.

Public Method GetConnectorDefinition(GetConnectorDefinitionRequest)

Retrieves information about a connector definition.

Public Method GetConnectorDefinitionAsync(GetConnectorDefinitionRequest, CancellationToken)

Retrieves information about a connector definition.

Public Method GetConnectorDefinitionVersion(GetConnectorDefinitionVersionRequest)

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

Public Method GetConnectorDefinitionVersionAsync(GetConnectorDefinitionVersionRequest, CancellationToken)

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

Public Method GetCoreDefinition(GetCoreDefinitionRequest)

Retrieves information about a core definition version.

Public Method GetCoreDefinitionAsync(GetCoreDefinitionRequest, CancellationToken)

Retrieves information about a core definition version.

Public Method GetCoreDefinitionVersion(GetCoreDefinitionVersionRequest)

Retrieves information about a core definition version.

Public Method GetCoreDefinitionVersionAsync(GetCoreDefinitionVersionRequest, CancellationToken)

Retrieves information about a core definition version.

Public Method GetDeploymentStatus(GetDeploymentStatusRequest)

Returns the status of a deployment.

Public Method GetDeploymentStatusAsync(GetDeploymentStatusRequest, CancellationToken)

Returns the status of a deployment.

Public Method GetDeviceDefinition(GetDeviceDefinitionRequest)

Retrieves information about a device definition.

Public Method GetDeviceDefinitionAsync(GetDeviceDefinitionRequest, CancellationToken)

Retrieves information about a device definition.

Public Method GetDeviceDefinitionVersion(GetDeviceDefinitionVersionRequest)

Retrieves information about a device definition version.

Public Method GetDeviceDefinitionVersionAsync(GetDeviceDefinitionVersionRequest, CancellationToken)

Retrieves information about a device definition version.

Public Method GetFunctionDefinition(GetFunctionDefinitionRequest)

Retrieves information about a Lambda function definition, including its creation time and latest version.

Public Method GetFunctionDefinitionAsync(GetFunctionDefinitionRequest, CancellationToken)

Retrieves information about a Lambda function definition, including its creation time and latest version.

Public Method GetFunctionDefinitionVersion(GetFunctionDefinitionVersionRequest)

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Public Method GetFunctionDefinitionVersionAsync(GetFunctionDefinitionVersionRequest, CancellationToken)

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Public Method GetGroup(GetGroupRequest)

Retrieves information about a group.

Public Method GetGroupAsync(GetGroupRequest, CancellationToken)

Retrieves information about a group.

Public Method GetGroupCertificateAuthority(GetGroupCertificateAuthorityRequest)

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

Public Method GetGroupCertificateAuthorityAsync(GetGroupCertificateAuthorityRequest, CancellationToken)

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

Public Method GetGroupCertificateConfiguration(GetGroupCertificateConfigurationRequest)

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

Public Method GetGroupCertificateConfigurationAsync(GetGroupCertificateConfigurationRequest, CancellationToken)

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

Public Method GetGroupVersion(GetGroupVersionRequest)

Retrieves information about a group version.

Public Method GetGroupVersionAsync(GetGroupVersionRequest, CancellationToken)

Retrieves information about a group version.

Public Method GetLoggerDefinition(GetLoggerDefinitionRequest)

Retrieves information about a logger definition.

Public Method GetLoggerDefinitionAsync(GetLoggerDefinitionRequest, CancellationToken)

Retrieves information about a logger definition.

Public Method GetLoggerDefinitionVersion(GetLoggerDefinitionVersionRequest)

Retrieves information about a logger definition version.

Public Method GetLoggerDefinitionVersionAsync(GetLoggerDefinitionVersionRequest, CancellationToken)

Retrieves information about a logger definition version.

Public Method GetResourceDefinition(GetResourceDefinitionRequest)

Retrieves information about a resource definition, including its creation time and latest version.

Public Method GetResourceDefinitionAsync(GetResourceDefinitionRequest, CancellationToken)

Retrieves information about a resource definition, including its creation time and latest version.

Public Method GetResourceDefinitionVersion(GetResourceDefinitionVersionRequest)

Retrieves information about a resource definition version, including which resources are included in the version.

Public Method GetResourceDefinitionVersionAsync(GetResourceDefinitionVersionRequest, CancellationToken)

Retrieves information about a resource definition version, including which resources are included in the version.

Public Method GetServiceRoleForAccount(GetServiceRoleForAccountRequest)

Retrieves the service role that is attached to your account.

Public Method GetServiceRoleForAccountAsync(GetServiceRoleForAccountRequest, CancellationToken)

Retrieves the service role that is attached to your account.

Public Method GetSubscriptionDefinition(GetSubscriptionDefinitionRequest)

Retrieves information about a subscription definition.

Public Method GetSubscriptionDefinitionAsync(GetSubscriptionDefinitionRequest, CancellationToken)

Retrieves information about a subscription definition.

Public Method GetSubscriptionDefinitionVersion(GetSubscriptionDefinitionVersionRequest)

Retrieves information about a subscription definition version.

Public Method GetSubscriptionDefinitionVersionAsync(GetSubscriptionDefinitionVersionRequest, CancellationToken)

Retrieves information about a subscription definition version.

Public Method GetThingRuntimeConfiguration(GetThingRuntimeConfigurationRequest)

Get the runtime configuration of a thing.

Public Method GetThingRuntimeConfigurationAsync(GetThingRuntimeConfigurationRequest, CancellationToken)

Get the runtime configuration of a thing.

Public Method ListBulkDeploymentDetailedReports(ListBulkDeploymentDetailedReportsRequest)

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Public Method ListBulkDeploymentDetailedReportsAsync(ListBulkDeploymentDetailedReportsRequest, CancellationToken)

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Public Method ListBulkDeployments(ListBulkDeploymentsRequest)

Returns a list of bulk deployments.

Public Method ListBulkDeploymentsAsync(ListBulkDeploymentsRequest, CancellationToken)

Returns a list of bulk deployments.

Public Method ListConnectorDefinitions(ListConnectorDefinitionsRequest)

Retrieves a list of connector definitions.

Public Method ListConnectorDefinitionsAsync(ListConnectorDefinitionsRequest, CancellationToken)

Retrieves a list of connector definitions.

Public Method ListConnectorDefinitionVersions(ListConnectorDefinitionVersionsRequest)

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

Public Method ListConnectorDefinitionVersionsAsync(ListConnectorDefinitionVersionsRequest, CancellationToken)

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

Public Method ListCoreDefinitions(ListCoreDefinitionsRequest)

Retrieves a list of core definitions.

Public Method ListCoreDefinitionsAsync(ListCoreDefinitionsRequest, CancellationToken)

Retrieves a list of core definitions.

Public Method ListCoreDefinitionVersions(ListCoreDefinitionVersionsRequest)

Lists the versions of a core definition.

Public Method ListCoreDefinitionVersionsAsync(ListCoreDefinitionVersionsRequest, CancellationToken)

Lists the versions of a core definition.

Public Method ListDeployments(ListDeploymentsRequest)

Returns a history of deployments for the group.

Public Method ListDeploymentsAsync(ListDeploymentsRequest, CancellationToken)

Returns a history of deployments for the group.

Public Method ListDeviceDefinitions(ListDeviceDefinitionsRequest)

Retrieves a list of device definitions.

Public Method ListDeviceDefinitionsAsync(ListDeviceDefinitionsRequest, CancellationToken)

Retrieves a list of device definitions.

Public Method ListDeviceDefinitionVersions(ListDeviceDefinitionVersionsRequest)

Lists the versions of a device definition.

Public Method ListDeviceDefinitionVersionsAsync(ListDeviceDefinitionVersionsRequest, CancellationToken)

Lists the versions of a device definition.

Public Method ListFunctionDefinitions(ListFunctionDefinitionsRequest)

Retrieves a list of Lambda function definitions.

Public Method ListFunctionDefinitionsAsync(ListFunctionDefinitionsRequest, CancellationToken)

Retrieves a list of Lambda function definitions.

Public Method ListFunctionDefinitionVersions(ListFunctionDefinitionVersionsRequest)

Lists the versions of a Lambda function definition.

Public Method ListFunctionDefinitionVersionsAsync(ListFunctionDefinitionVersionsRequest, CancellationToken)

Lists the versions of a Lambda function definition.

Public Method ListGroupCertificateAuthorities(ListGroupCertificateAuthoritiesRequest)

Retrieves the current CAs for a group.

Public Method ListGroupCertificateAuthoritiesAsync(ListGroupCertificateAuthoritiesRequest, CancellationToken)

Retrieves the current CAs for a group.

Public Method ListGroups(ListGroupsRequest)

Retrieves a list of groups.

Public Method ListGroupsAsync(ListGroupsRequest, CancellationToken)

Retrieves a list of groups.

Public Method ListGroupVersions(ListGroupVersionsRequest)

Lists the versions of a group.

Public Method ListGroupVersionsAsync(ListGroupVersionsRequest, CancellationToken)

Lists the versions of a group.

Public Method ListLoggerDefinitions(ListLoggerDefinitionsRequest)

Retrieves a list of logger definitions.

Public Method ListLoggerDefinitionsAsync(ListLoggerDefinitionsRequest, CancellationToken)

Retrieves a list of logger definitions.

Public Method ListLoggerDefinitionVersions(ListLoggerDefinitionVersionsRequest)

Lists the versions of a logger definition.

Public Method ListLoggerDefinitionVersionsAsync(ListLoggerDefinitionVersionsRequest, CancellationToken)

Lists the versions of a logger definition.

Public Method ListResourceDefinitions(ListResourceDefinitionsRequest)

Retrieves a list of resource definitions.

Public Method ListResourceDefinitionsAsync(ListResourceDefinitionsRequest, CancellationToken)

Retrieves a list of resource definitions.

Public Method ListResourceDefinitionVersions(ListResourceDefinitionVersionsRequest)

Lists the versions of a resource definition.

Public Method ListResourceDefinitionVersionsAsync(ListResourceDefinitionVersionsRequest, CancellationToken)

Lists the versions of a resource definition.

Public Method ListSubscriptionDefinitions(ListSubscriptionDefinitionsRequest)

Retrieves a list of subscription definitions.

Public Method ListSubscriptionDefinitionsAsync(ListSubscriptionDefinitionsRequest, CancellationToken)

Retrieves a list of subscription definitions.

Public Method ListSubscriptionDefinitionVersions(ListSubscriptionDefinitionVersionsRequest)

Lists the versions of a subscription definition.

Public Method ListSubscriptionDefinitionVersionsAsync(ListSubscriptionDefinitionVersionsRequest, CancellationToken)

Lists the versions of a subscription definition.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieves a list of resource tags for a resource arn.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieves a list of resource tags for a resource arn.

Public Method ResetDeployments(ResetDeploymentsRequest)

Resets a group's deployments.

Public Method ResetDeploymentsAsync(ResetDeploymentsRequest, CancellationToken)

Resets a group's deployments.

Public Method StartBulkDeployment(StartBulkDeploymentRequest)

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

Public Method StartBulkDeploymentAsync(StartBulkDeploymentRequest, CancellationToken)

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

Public Method StopBulkDeployment(StopBulkDeploymentRequest)

Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

Public Method StopBulkDeploymentAsync(StopBulkDeploymentRequest, CancellationToken)

Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

Public Method TagResource(TagResourceRequest)

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

Public Method UntagResource(UntagResourceRequest)

Remove resource tags from a Greengrass Resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Remove resource tags from a Greengrass Resource.

Public Method UpdateConnectivityInfo(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.

Public Method UpdateConnectivityInfoAsync(UpdateConnectivityInfoRequest, CancellationToken)

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.

Public Method UpdateConnectorDefinition(UpdateConnectorDefinitionRequest)

Updates a connector definition.

Public Method UpdateConnectorDefinitionAsync(UpdateConnectorDefinitionRequest, CancellationToken)

Updates a connector definition.

Public Method UpdateCoreDefinition(UpdateCoreDefinitionRequest)

Updates a core definition.

Public Method UpdateCoreDefinitionAsync(UpdateCoreDefinitionRequest, CancellationToken)

Updates a core definition.

Public Method UpdateDeviceDefinition(UpdateDeviceDefinitionRequest)

Updates a device definition.

Public Method UpdateDeviceDefinitionAsync(UpdateDeviceDefinitionRequest, CancellationToken)

Updates a device definition.

Public Method UpdateFunctionDefinition(UpdateFunctionDefinitionRequest)

Updates a Lambda function definition.

Public Method UpdateFunctionDefinitionAsync(UpdateFunctionDefinitionRequest, CancellationToken)

Updates a Lambda function definition.

Public Method UpdateGroup(UpdateGroupRequest)

Updates a group.

Public Method UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

Updates a group.

Public Method UpdateGroupCertificateConfiguration(UpdateGroupCertificateConfigurationRequest)

Updates the Certificate expiry time for a group.

Public Method UpdateGroupCertificateConfigurationAsync(UpdateGroupCertificateConfigurationRequest, CancellationToken)

Updates the Certificate expiry time for a group.

Public Method UpdateLoggerDefinition(UpdateLoggerDefinitionRequest)

Updates a logger definition.

Public Method UpdateLoggerDefinitionAsync(UpdateLoggerDefinitionRequest, CancellationToken)

Updates a logger definition.

Public Method UpdateResourceDefinition(UpdateResourceDefinitionRequest)

Updates a resource definition.

Public Method UpdateResourceDefinitionAsync(UpdateResourceDefinitionRequest, CancellationToken)

Updates a resource definition.

Public Method UpdateSubscriptionDefinition(UpdateSubscriptionDefinitionRequest)

Updates a subscription definition.

Public Method UpdateSubscriptionDefinitionAsync(UpdateSubscriptionDefinitionRequest, CancellationToken)

Updates a subscription definition.

Public Method UpdateThingRuntimeConfiguration(UpdateThingRuntimeConfigurationRequest)

Updates the runtime configuration of a thing.

Public Method UpdateThingRuntimeConfigurationAsync(UpdateThingRuntimeConfigurationRequest, CancellationToken)

Updates the runtime configuration of a thing.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5