amazonka-greengrass-2.0: Amazon Greengrass SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Greengrass.Lens

Contents

Description

 
Synopsis

Operations

AssociateRoleToGroup

associateRoleToGroup_roleArn :: Lens' AssociateRoleToGroup Text Source #

The ARN of the role you wish to associate with this group. The existence of the role is not validated.

associateRoleToGroupResponse_associatedAt :: Lens' AssociateRoleToGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the role ARN was associated with the group.

AssociateServiceRoleToAccount

associateServiceRoleToAccount_roleArn :: Lens' AssociateServiceRoleToAccount Text Source #

The ARN of the service role you wish to associate with your account.

associateServiceRoleToAccountResponse_associatedAt :: Lens' AssociateServiceRoleToAccountResponse (Maybe Text) Source #

The time when the service role was associated with the account.

CreateConnectorDefinition

createConnectorDefinition_amznClientToken :: Lens' CreateConnectorDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createConnectorDefinition_initialVersion :: Lens' CreateConnectorDefinition (Maybe ConnectorDefinitionVersion) Source #

Information about the initial version of the connector definition.

createConnectorDefinitionResponse_creationTimestamp :: Lens' CreateConnectorDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createConnectorDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateConnectorDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createConnectorDefinitionResponse_latestVersion :: Lens' CreateConnectorDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createConnectorDefinitionResponse_latestVersionArn :: Lens' CreateConnectorDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateConnectorDefinitionVersion

createConnectorDefinitionVersion_connectors :: Lens' CreateConnectorDefinitionVersion (Maybe [Connector]) Source #

A list of references to connectors in this version, with their corresponding configuration settings.

createConnectorDefinitionVersionResponse_creationTimestamp :: Lens' CreateConnectorDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createConnectorDefinitionVersionResponse_id :: Lens' CreateConnectorDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateCoreDefinition

createCoreDefinition_amznClientToken :: Lens' CreateCoreDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createCoreDefinition_initialVersion :: Lens' CreateCoreDefinition (Maybe CoreDefinitionVersion) Source #

Information about the initial version of the core definition.

createCoreDefinitionResponse_creationTimestamp :: Lens' CreateCoreDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createCoreDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateCoreDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createCoreDefinitionResponse_latestVersion :: Lens' CreateCoreDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createCoreDefinitionResponse_latestVersionArn :: Lens' CreateCoreDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateCoreDefinitionVersion

createCoreDefinitionVersion_amznClientToken :: Lens' CreateCoreDefinitionVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createCoreDefinitionVersion_cores :: Lens' CreateCoreDefinitionVersion (Maybe [Core]) Source #

A list of cores in the core definition version.

createCoreDefinitionVersionResponse_creationTimestamp :: Lens' CreateCoreDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createCoreDefinitionVersionResponse_id :: Lens' CreateCoreDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateDeployment

createDeployment_amznClientToken :: Lens' CreateDeployment (Maybe Text) Source #

A client token used to correlate requests and responses.

createDeployment_deploymentId :: Lens' CreateDeployment (Maybe Text) Source #

The ID of the deployment if you wish to redeploy a previous deployment.

createDeployment_groupVersionId :: Lens' CreateDeployment (Maybe Text) Source #

The ID of the group version to be deployed.

createDeployment_groupId :: Lens' CreateDeployment Text Source #

The ID of the Greengrass group.

createDeployment_deploymentType :: Lens' CreateDeployment DeploymentType Source #

The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

CreateDeviceDefinition

createDeviceDefinition_amznClientToken :: Lens' CreateDeviceDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createDeviceDefinition_initialVersion :: Lens' CreateDeviceDefinition (Maybe DeviceDefinitionVersion) Source #

Information about the initial version of the device definition.

createDeviceDefinitionResponse_creationTimestamp :: Lens' CreateDeviceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createDeviceDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateDeviceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createDeviceDefinitionResponse_latestVersion :: Lens' CreateDeviceDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createDeviceDefinitionResponse_latestVersionArn :: Lens' CreateDeviceDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateDeviceDefinitionVersion

createDeviceDefinitionVersion_amznClientToken :: Lens' CreateDeviceDefinitionVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createDeviceDefinitionVersionResponse_creationTimestamp :: Lens' CreateDeviceDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createDeviceDefinitionVersionResponse_id :: Lens' CreateDeviceDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateFunctionDefinition

createFunctionDefinition_amznClientToken :: Lens' CreateFunctionDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createFunctionDefinition_initialVersion :: Lens' CreateFunctionDefinition (Maybe FunctionDefinitionVersion) Source #

Information about the initial version of the function definition.

createFunctionDefinitionResponse_creationTimestamp :: Lens' CreateFunctionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createFunctionDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateFunctionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createFunctionDefinitionResponse_latestVersion :: Lens' CreateFunctionDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createFunctionDefinitionResponse_latestVersionArn :: Lens' CreateFunctionDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateFunctionDefinitionVersion

createFunctionDefinitionVersion_amznClientToken :: Lens' CreateFunctionDefinitionVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createFunctionDefinitionVersion_defaultConfig :: Lens' CreateFunctionDefinitionVersion (Maybe FunctionDefaultConfig) Source #

The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.

createFunctionDefinitionVersion_functions :: Lens' CreateFunctionDefinitionVersion (Maybe [Function]) Source #

A list of Lambda functions in this function definition version.

createFunctionDefinitionVersionResponse_creationTimestamp :: Lens' CreateFunctionDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createFunctionDefinitionVersionResponse_id :: Lens' CreateFunctionDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateGroup

createGroup_amznClientToken :: Lens' CreateGroup (Maybe Text) Source #

A client token used to correlate requests and responses.

createGroup_initialVersion :: Lens' CreateGroup (Maybe GroupVersion) Source #

Information about the initial version of the group.

createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text)) Source #

Tag(s) to add to the new resource.

createGroup_name :: Lens' CreateGroup Text Source #

The name of the group.

createGroupResponse_creationTimestamp :: Lens' CreateGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createGroupResponse_lastUpdatedTimestamp :: Lens' CreateGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createGroupResponse_latestVersion :: Lens' CreateGroupResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createGroupResponse_latestVersionArn :: Lens' CreateGroupResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateGroupCertificateAuthority

createGroupCertificateAuthority_amznClientToken :: Lens' CreateGroupCertificateAuthority (Maybe Text) Source #

A client token used to correlate requests and responses.

CreateGroupVersion

createGroupVersion_amznClientToken :: Lens' CreateGroupVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createGroupVersion_connectorDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the connector definition version for this group.

createGroupVersion_coreDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the core definition version for this group.

createGroupVersion_deviceDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the device definition version for this group.

createGroupVersion_functionDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the function definition version for this group.

createGroupVersion_loggerDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the logger definition version for this group.

createGroupVersion_resourceDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the resource definition version for this group.

createGroupVersion_subscriptionDefinitionVersionArn :: Lens' CreateGroupVersion (Maybe Text) Source #

The ARN of the subscription definition version for this group.

createGroupVersionResponse_creationTimestamp :: Lens' CreateGroupVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createGroupVersionResponse_id :: Lens' CreateGroupVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateLoggerDefinition

createLoggerDefinition_amznClientToken :: Lens' CreateLoggerDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createLoggerDefinition_initialVersion :: Lens' CreateLoggerDefinition (Maybe LoggerDefinitionVersion) Source #

Information about the initial version of the logger definition.

createLoggerDefinitionResponse_creationTimestamp :: Lens' CreateLoggerDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createLoggerDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateLoggerDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createLoggerDefinitionResponse_latestVersion :: Lens' CreateLoggerDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createLoggerDefinitionResponse_latestVersionArn :: Lens' CreateLoggerDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateLoggerDefinitionVersion

createLoggerDefinitionVersion_amznClientToken :: Lens' CreateLoggerDefinitionVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createLoggerDefinitionVersionResponse_creationTimestamp :: Lens' CreateLoggerDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createLoggerDefinitionVersionResponse_id :: Lens' CreateLoggerDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateResourceDefinition

createResourceDefinition_amznClientToken :: Lens' CreateResourceDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createResourceDefinition_initialVersion :: Lens' CreateResourceDefinition (Maybe ResourceDefinitionVersion) Source #

Information about the initial version of the resource definition.

createResourceDefinitionResponse_creationTimestamp :: Lens' CreateResourceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createResourceDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateResourceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

createResourceDefinitionResponse_latestVersion :: Lens' CreateResourceDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

createResourceDefinitionResponse_latestVersionArn :: Lens' CreateResourceDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

CreateResourceDefinitionVersion

createResourceDefinitionVersion_amznClientToken :: Lens' CreateResourceDefinitionVersion (Maybe Text) Source #

A client token used to correlate requests and responses.

createResourceDefinitionVersionResponse_creationTimestamp :: Lens' CreateResourceDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

createResourceDefinitionVersionResponse_id :: Lens' CreateResourceDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

CreateSoftwareUpdateJob

createSoftwareUpdateJob_amznClientToken :: Lens' CreateSoftwareUpdateJob (Maybe Text) Source #

A client token used to correlate requests and responses.

createSoftwareUpdateJobResponse_platformSoftwareVersion :: Lens' CreateSoftwareUpdateJobResponse (Maybe Text) Source #

The software version installed on the device or devices after the update.

CreateSubscriptionDefinition

createSubscriptionDefinition_amznClientToken :: Lens' CreateSubscriptionDefinition (Maybe Text) Source #

A client token used to correlate requests and responses.

createSubscriptionDefinition_initialVersion :: Lens' CreateSubscriptionDefinition (Maybe SubscriptionDefinitionVersion) Source #

Information about the initial version of the subscription definition.

createSubscriptionDefinitionResponse_creationTimestamp :: Lens' CreateSubscriptionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

createSubscriptionDefinitionResponse_lastUpdatedTimestamp :: Lens' CreateSubscriptionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

CreateSubscriptionDefinitionVersion

createSubscriptionDefinitionVersionResponse_id :: Lens' CreateSubscriptionDefinitionVersionResponse (Maybe Text) Source #

The ID of the parent definition that the version is associated with.

DeleteConnectorDefinition

DeleteCoreDefinition

DeleteDeviceDefinition

DeleteFunctionDefinition

DeleteGroup

deleteGroup_groupId :: Lens' DeleteGroup Text Source #

The ID of the Greengrass group.

DeleteLoggerDefinition

DeleteResourceDefinition

DeleteSubscriptionDefinition

DisassociateRoleFromGroup

disassociateRoleFromGroupResponse_disassociatedAt :: Lens' DisassociateRoleFromGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the role was disassociated from the group.

DisassociateServiceRoleFromAccount

GetAssociatedRole

getAssociatedRole_groupId :: Lens' GetAssociatedRole Text Source #

The ID of the Greengrass group.

getAssociatedRoleResponse_associatedAt :: Lens' GetAssociatedRoleResponse (Maybe Text) Source #

The time when the role was associated with the group.

getAssociatedRoleResponse_roleArn :: Lens' GetAssociatedRoleResponse (Maybe Text) Source #

The ARN of the role that is associated with the group.

GetBulkDeploymentStatus

getBulkDeploymentStatusResponse_createdAt :: Lens' GetBulkDeploymentStatusResponse (Maybe Text) Source #

The time, in ISO format, when the deployment was created.

GetConnectivityInfo

getConnectivityInfoResponse_message :: Lens' GetConnectivityInfoResponse (Maybe Text) Source #

A message about the connectivity info request.

GetConnectorDefinition

getConnectorDefinitionResponse_creationTimestamp :: Lens' GetConnectorDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getConnectorDefinitionResponse_lastUpdatedTimestamp :: Lens' GetConnectorDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getConnectorDefinitionResponse_latestVersion :: Lens' GetConnectorDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getConnectorDefinitionResponse_latestVersionArn :: Lens' GetConnectorDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetConnectorDefinitionVersion

getConnectorDefinitionVersion_nextToken :: Lens' GetConnectorDefinitionVersion (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

getConnectorDefinitionVersion_connectorDefinitionVersionId :: Lens' GetConnectorDefinitionVersion Text Source #

The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getConnectorDefinitionVersionResponse_creationTimestamp :: Lens' GetConnectorDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the connector definition version was created.

getConnectorDefinitionVersionResponse_nextToken :: Lens' GetConnectorDefinitionVersionResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

GetCoreDefinition

getCoreDefinitionResponse_creationTimestamp :: Lens' GetCoreDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getCoreDefinitionResponse_lastUpdatedTimestamp :: Lens' GetCoreDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getCoreDefinitionResponse_latestVersion :: Lens' GetCoreDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getCoreDefinitionResponse_latestVersionArn :: Lens' GetCoreDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetCoreDefinitionVersion

getCoreDefinitionVersion_coreDefinitionVersionId :: Lens' GetCoreDefinitionVersion Text Source #

The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getCoreDefinitionVersionResponse_creationTimestamp :: Lens' GetCoreDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the core definition version was created.

getCoreDefinitionVersionResponse_nextToken :: Lens' GetCoreDefinitionVersionResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

GetDeploymentStatus

getDeploymentStatusResponse_deploymentStatus :: Lens' GetDeploymentStatusResponse (Maybe Text) Source #

The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.

getDeploymentStatusResponse_updatedAt :: Lens' GetDeploymentStatusResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the deployment status was updated.

GetDeviceDefinition

getDeviceDefinitionResponse_creationTimestamp :: Lens' GetDeviceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getDeviceDefinitionResponse_lastUpdatedTimestamp :: Lens' GetDeviceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getDeviceDefinitionResponse_latestVersion :: Lens' GetDeviceDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getDeviceDefinitionResponse_latestVersionArn :: Lens' GetDeviceDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetDeviceDefinitionVersion

getDeviceDefinitionVersion_nextToken :: Lens' GetDeviceDefinitionVersion (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

getDeviceDefinitionVersion_deviceDefinitionVersionId :: Lens' GetDeviceDefinitionVersion Text Source #

The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getDeviceDefinitionVersionResponse_creationTimestamp :: Lens' GetDeviceDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the device definition version was created.

getDeviceDefinitionVersionResponse_nextToken :: Lens' GetDeviceDefinitionVersionResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

GetFunctionDefinition

getFunctionDefinitionResponse_creationTimestamp :: Lens' GetFunctionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getFunctionDefinitionResponse_lastUpdatedTimestamp :: Lens' GetFunctionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getFunctionDefinitionResponse_latestVersion :: Lens' GetFunctionDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getFunctionDefinitionResponse_latestVersionArn :: Lens' GetFunctionDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetFunctionDefinitionVersion

getFunctionDefinitionVersion_nextToken :: Lens' GetFunctionDefinitionVersion (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

getFunctionDefinitionVersion_functionDefinitionVersionId :: Lens' GetFunctionDefinitionVersion Text Source #

The ID of the function definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListFunctionDefinitionVersions'' requests. If the version is the last one that was associated with a function definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getFunctionDefinitionVersionResponse_creationTimestamp :: Lens' GetFunctionDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the function definition version was created.

getFunctionDefinitionVersionResponse_nextToken :: Lens' GetFunctionDefinitionVersionResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

GetGroup

getGroup_groupId :: Lens' GetGroup Text Source #

The ID of the Greengrass group.

getGroupResponse_creationTimestamp :: Lens' GetGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getGroupResponse_lastUpdatedTimestamp :: Lens' GetGroupResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getGroupResponse_latestVersion :: Lens' GetGroupResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getGroupResponse_latestVersionArn :: Lens' GetGroupResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

getGroupResponse_tags :: Lens' GetGroupResponse (Maybe (HashMap Text Text)) Source #

Tag(s) attached to the resource arn.

getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #

The response's http status code.

GetGroupCertificateAuthority

GetGroupCertificateConfiguration

getGroupCertificateConfigurationResponse_certificateAuthorityExpiryInMilliseconds :: Lens' GetGroupCertificateConfigurationResponse (Maybe Text) Source #

The amount of time remaining before the certificate authority expires, in milliseconds.

GetGroupVersion

getGroupVersion_groupVersionId :: Lens' GetGroupVersion Text Source #

The ID of the group version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListGroupVersions'' requests. If the version is the last one that was associated with a group, the value also maps to the ''LatestVersion'' property of the corresponding ''GroupInformation'' object.

getGroupVersion_groupId :: Lens' GetGroupVersion Text Source #

The ID of the Greengrass group.

getGroupVersionResponse_creationTimestamp :: Lens' GetGroupVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the group version was created.

getGroupVersionResponse_definition :: Lens' GetGroupVersionResponse (Maybe GroupVersion) Source #

Information about the group version definition.

getGroupVersionResponse_id :: Lens' GetGroupVersionResponse (Maybe Text) Source #

The ID of the group that the version is associated with.

GetLoggerDefinition

getLoggerDefinitionResponse_creationTimestamp :: Lens' GetLoggerDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getLoggerDefinitionResponse_lastUpdatedTimestamp :: Lens' GetLoggerDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getLoggerDefinitionResponse_latestVersion :: Lens' GetLoggerDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getLoggerDefinitionResponse_latestVersionArn :: Lens' GetLoggerDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetLoggerDefinitionVersion

getLoggerDefinitionVersion_nextToken :: Lens' GetLoggerDefinitionVersion (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

getLoggerDefinitionVersion_loggerDefinitionVersionId :: Lens' GetLoggerDefinitionVersion Text Source #

The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getLoggerDefinitionVersionResponse_creationTimestamp :: Lens' GetLoggerDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the logger definition version was created.

GetResourceDefinition

getResourceDefinitionResponse_creationTimestamp :: Lens' GetResourceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getResourceDefinitionResponse_lastUpdatedTimestamp :: Lens' GetResourceDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getResourceDefinitionResponse_latestVersion :: Lens' GetResourceDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getResourceDefinitionResponse_latestVersionArn :: Lens' GetResourceDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetResourceDefinitionVersion

getResourceDefinitionVersion_resourceDefinitionVersionId :: Lens' GetResourceDefinitionVersion Text Source #

The ID of the resource definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListResourceDefinitionVersions'' requests. If the version is the last one that was associated with a resource definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getResourceDefinitionVersionResponse_creationTimestamp :: Lens' GetResourceDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the resource definition version was created.

GetServiceRoleForAccount

getServiceRoleForAccountResponse_associatedAt :: Lens' GetServiceRoleForAccountResponse (Maybe Text) Source #

The time when the service role was associated with the account.

getServiceRoleForAccountResponse_roleArn :: Lens' GetServiceRoleForAccountResponse (Maybe Text) Source #

The ARN of the role which is associated with the account.

GetSubscriptionDefinition

getSubscriptionDefinitionResponse_creationTimestamp :: Lens' GetSubscriptionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

getSubscriptionDefinitionResponse_lastUpdatedTimestamp :: Lens' GetSubscriptionDefinitionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

getSubscriptionDefinitionResponse_latestVersion :: Lens' GetSubscriptionDefinitionResponse (Maybe Text) Source #

The ID of the latest version associated with the definition.

getSubscriptionDefinitionResponse_latestVersionArn :: Lens' GetSubscriptionDefinitionResponse (Maybe Text) Source #

The ARN of the latest version associated with the definition.

GetSubscriptionDefinitionVersion

getSubscriptionDefinitionVersion_nextToken :: Lens' GetSubscriptionDefinitionVersion (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

getSubscriptionDefinitionVersion_subscriptionDefinitionVersionId :: Lens' GetSubscriptionDefinitionVersion Text Source #

The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

getSubscriptionDefinitionVersionResponse_creationTimestamp :: Lens' GetSubscriptionDefinitionVersionResponse (Maybe Text) Source #

The time, in milliseconds since the epoch, when the subscription definition version was created.

getSubscriptionDefinitionVersionResponse_nextToken :: Lens' GetSubscriptionDefinitionVersionResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

GetThingRuntimeConfiguration

ListBulkDeploymentDetailedReports

listBulkDeploymentDetailedReports_maxResults :: Lens' ListBulkDeploymentDetailedReports (Maybe Text) Source #

The maximum number of results to be returned per request.

listBulkDeploymentDetailedReports_nextToken :: Lens' ListBulkDeploymentDetailedReports (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listBulkDeploymentDetailedReportsResponse_deployments :: Lens' ListBulkDeploymentDetailedReportsResponse (Maybe [BulkDeploymentResult]) Source #

A list of the individual group deployments in the bulk deployment operation.

listBulkDeploymentDetailedReportsResponse_nextToken :: Lens' ListBulkDeploymentDetailedReportsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListBulkDeployments

listBulkDeployments_maxResults :: Lens' ListBulkDeployments (Maybe Text) Source #

The maximum number of results to be returned per request.

listBulkDeployments_nextToken :: Lens' ListBulkDeployments (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listBulkDeploymentsResponse_nextToken :: Lens' ListBulkDeploymentsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListConnectorDefinitionVersions

listConnectorDefinitionVersions_maxResults :: Lens' ListConnectorDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listConnectorDefinitionVersions_nextToken :: Lens' ListConnectorDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listConnectorDefinitionVersionsResponse_nextToken :: Lens' ListConnectorDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListConnectorDefinitions

listConnectorDefinitions_maxResults :: Lens' ListConnectorDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listConnectorDefinitions_nextToken :: Lens' ListConnectorDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listConnectorDefinitionsResponse_nextToken :: Lens' ListConnectorDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListCoreDefinitionVersions

listCoreDefinitionVersions_maxResults :: Lens' ListCoreDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listCoreDefinitionVersions_nextToken :: Lens' ListCoreDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listCoreDefinitionVersionsResponse_nextToken :: Lens' ListCoreDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListCoreDefinitions

listCoreDefinitions_maxResults :: Lens' ListCoreDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listCoreDefinitions_nextToken :: Lens' ListCoreDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listCoreDefinitionsResponse_nextToken :: Lens' ListCoreDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListDeployments

listDeployments_maxResults :: Lens' ListDeployments (Maybe Text) Source #

The maximum number of results to be returned per request.

listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listDeployments_groupId :: Lens' ListDeployments Text Source #

The ID of the Greengrass group.

listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Deployment]) Source #

A list of deployments for the requested groups.

listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListDeviceDefinitionVersions

listDeviceDefinitionVersions_maxResults :: Lens' ListDeviceDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listDeviceDefinitionVersions_nextToken :: Lens' ListDeviceDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listDeviceDefinitionVersionsResponse_nextToken :: Lens' ListDeviceDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListDeviceDefinitions

listDeviceDefinitions_maxResults :: Lens' ListDeviceDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listDeviceDefinitions_nextToken :: Lens' ListDeviceDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listDeviceDefinitionsResponse_nextToken :: Lens' ListDeviceDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListFunctionDefinitionVersions

listFunctionDefinitionVersions_maxResults :: Lens' ListFunctionDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listFunctionDefinitionVersions_nextToken :: Lens' ListFunctionDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listFunctionDefinitionVersionsResponse_nextToken :: Lens' ListFunctionDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListFunctionDefinitions

listFunctionDefinitions_maxResults :: Lens' ListFunctionDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listFunctionDefinitions_nextToken :: Lens' ListFunctionDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listFunctionDefinitionsResponse_nextToken :: Lens' ListFunctionDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListGroupCertificateAuthorities

ListGroupVersions

listGroupVersions_maxResults :: Lens' ListGroupVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listGroupVersions_nextToken :: Lens' ListGroupVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listGroupVersions_groupId :: Lens' ListGroupVersions Text Source #

The ID of the Greengrass group.

listGroupVersionsResponse_nextToken :: Lens' ListGroupVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListGroups

listGroups_maxResults :: Lens' ListGroups (Maybe Text) Source #

The maximum number of results to be returned per request.

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListLoggerDefinitionVersions

listLoggerDefinitionVersions_maxResults :: Lens' ListLoggerDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listLoggerDefinitionVersions_nextToken :: Lens' ListLoggerDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listLoggerDefinitionVersionsResponse_nextToken :: Lens' ListLoggerDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListLoggerDefinitions

listLoggerDefinitions_maxResults :: Lens' ListLoggerDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listLoggerDefinitions_nextToken :: Lens' ListLoggerDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listLoggerDefinitionsResponse_nextToken :: Lens' ListLoggerDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListResourceDefinitionVersions

listResourceDefinitionVersions_maxResults :: Lens' ListResourceDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listResourceDefinitionVersions_nextToken :: Lens' ListResourceDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listResourceDefinitionVersionsResponse_nextToken :: Lens' ListResourceDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListResourceDefinitions

listResourceDefinitions_maxResults :: Lens' ListResourceDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listResourceDefinitions_nextToken :: Lens' ListResourceDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listResourceDefinitionsResponse_nextToken :: Lens' ListResourceDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListSubscriptionDefinitionVersions

listSubscriptionDefinitionVersions_maxResults :: Lens' ListSubscriptionDefinitionVersions (Maybe Text) Source #

The maximum number of results to be returned per request.

listSubscriptionDefinitionVersions_nextToken :: Lens' ListSubscriptionDefinitionVersions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listSubscriptionDefinitionVersionsResponse_nextToken :: Lens' ListSubscriptionDefinitionVersionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListSubscriptionDefinitions

listSubscriptionDefinitions_maxResults :: Lens' ListSubscriptionDefinitions (Maybe Text) Source #

The maximum number of results to be returned per request.

listSubscriptionDefinitions_nextToken :: Lens' ListSubscriptionDefinitions (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

listSubscriptionDefinitionsResponse_nextToken :: Lens' ListSubscriptionDefinitionsResponse (Maybe Text) Source #

The token for the next set of results, or ''null'' if there are no additional results.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

ResetDeployments

resetDeployments_amznClientToken :: Lens' ResetDeployments (Maybe Text) Source #

A client token used to correlate requests and responses.

resetDeployments_force :: Lens' ResetDeployments (Maybe Bool) Source #

If true, performs a best-effort only core reset.

resetDeployments_groupId :: Lens' ResetDeployments Text Source #

The ID of the Greengrass group.

StartBulkDeployment

startBulkDeployment_amznClientToken :: Lens' StartBulkDeployment (Maybe Text) Source #

A client token used to correlate requests and responses.

startBulkDeployment_executionRoleArn :: Lens' StartBulkDeployment Text Source #

The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

startBulkDeployment_inputFileUri :: Lens' StartBulkDeployment Text Source #

The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

StopBulkDeployment

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

An array of tag keys to delete

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

UpdateConnectivityInfo

updateConnectivityInfoResponse_message :: Lens' UpdateConnectivityInfoResponse (Maybe Text) Source #

A message about the connectivity info update request.

UpdateConnectorDefinition

UpdateCoreDefinition

UpdateDeviceDefinition

UpdateFunctionDefinition

UpdateGroup

updateGroup_name :: Lens' UpdateGroup (Maybe Text) Source #

The name of the definition.

updateGroup_groupId :: Lens' UpdateGroup Text Source #

The ID of the Greengrass group.

UpdateGroupCertificateConfiguration

updateGroupCertificateConfiguration_certificateExpiryInMilliseconds :: Lens' UpdateGroupCertificateConfiguration (Maybe Text) Source #

The amount of time remaining before the certificate expires, in milliseconds.

UpdateLoggerDefinition

UpdateResourceDefinition

UpdateSubscriptionDefinition

UpdateThingRuntimeConfiguration

Types

BulkDeployment

bulkDeployment_createdAt :: Lens' BulkDeployment (Maybe Text) Source #

The time, in ISO format, when the deployment was created.

BulkDeploymentMetrics

bulkDeploymentMetrics_invalidInputRecords :: Lens' BulkDeploymentMetrics (Maybe Int) Source #

The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version.

bulkDeploymentMetrics_recordsProcessed :: Lens' BulkDeploymentMetrics (Maybe Int) Source #

The total number of group records from the input file that have been processed so far, or attempted.

bulkDeploymentMetrics_retryAttempts :: Lens' BulkDeploymentMetrics (Maybe Int) Source #

The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times.

BulkDeploymentResult

bulkDeploymentResult_createdAt :: Lens' BulkDeploymentResult (Maybe Text) Source #

The time, in ISO format, when the deployment was created.

bulkDeploymentResult_deploymentStatus :: Lens' BulkDeploymentResult (Maybe Text) Source #

The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.

bulkDeploymentResult_errorMessage :: Lens' BulkDeploymentResult (Maybe Text) Source #

The error message for a failed deployment

ConnectivityInfo

connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text) Source #

The endpoint for the Greengrass core. Can be an IP address or DNS.

connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text) Source #

The ID of the connectivity information.

connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Int) Source #

The port of the Greengrass core. Usually 8883.

Connector

connector_parameters :: Lens' Connector (Maybe (HashMap Text Text)) Source #

The parameters or configuration that the connector uses.

connector_connectorArn :: Lens' Connector Text Source #

The ARN of the connector.

connector_id :: Lens' Connector Text Source #

A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

ConnectorDefinitionVersion

connectorDefinitionVersion_connectors :: Lens' ConnectorDefinitionVersion (Maybe [Connector]) Source #

A list of references to connectors in this version, with their corresponding configuration settings.

Core

core_syncShadow :: Lens' Core (Maybe Bool) Source #

If true, the core's local shadow is automatically synced with the cloud.

core_thingArn :: Lens' Core Text Source #

The ARN of the thing which is the core.

core_id :: Lens' Core Text Source #

A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

core_certificateArn :: Lens' Core Text Source #

The ARN of the certificate associated with the core.

CoreDefinitionVersion

coreDefinitionVersion_cores :: Lens' CoreDefinitionVersion (Maybe [Core]) Source #

A list of cores in the core definition version.

DefinitionInformation

definitionInformation_creationTimestamp :: Lens' DefinitionInformation (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was created.

definitionInformation_lastUpdatedTimestamp :: Lens' DefinitionInformation (Maybe Text) Source #

The time, in milliseconds since the epoch, when the definition was last updated.

definitionInformation_latestVersion :: Lens' DefinitionInformation (Maybe Text) Source #

The ID of the latest version associated with the definition.

definitionInformation_latestVersionArn :: Lens' DefinitionInformation (Maybe Text) Source #

The ARN of the latest version associated with the definition.

Deployment

deployment_createdAt :: Lens' Deployment (Maybe Text) Source #

The time, in milliseconds since the epoch, when the deployment was created.

deployment_deploymentArn :: Lens' Deployment (Maybe Text) Source #

The ARN of the deployment.

deployment_deploymentId :: Lens' Deployment (Maybe Text) Source #

The ID of the deployment.

deployment_groupArn :: Lens' Deployment (Maybe Text) Source #

The ARN of the group for this deployment.

Device

device_syncShadow :: Lens' Device (Maybe Bool) Source #

If true, the device's local shadow will be automatically synced with the cloud.

device_thingArn :: Lens' Device Text Source #

The thing ARN of the device.

device_id :: Lens' Device Text Source #

A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

device_certificateArn :: Lens' Device Text Source #

The ARN of the certificate associated with the device.

DeviceDefinitionVersion

deviceDefinitionVersion_devices :: Lens' DeviceDefinitionVersion (Maybe [Device]) Source #

A list of devices in the definition version.

ErrorDetail

Function

function_functionArn :: Lens' Function (Maybe Text) Source #

The ARN of the Lambda function.

function_functionConfiguration :: Lens' Function (Maybe FunctionConfiguration) Source #

The configuration of the Lambda function.

function_id :: Lens' Function Text Source #

A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

FunctionConfiguration

functionConfiguration_encodingType :: Lens' FunctionConfiguration (Maybe EncodingType) Source #

The expected encoding type of the input payload for the function. The default is ''json''.

functionConfiguration_functionRuntimeOverride :: Lens' FunctionConfiguration (Maybe Text) Source #

The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.

functionConfiguration_memorySize :: Lens' FunctionConfiguration (Maybe Int) Source #

The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.

functionConfiguration_pinned :: Lens' FunctionConfiguration (Maybe Bool) Source #

True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.

functionConfiguration_timeout :: Lens' FunctionConfiguration (Maybe Int) Source #

The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.

FunctionConfigurationEnvironment

functionConfigurationEnvironment_accessSysfs :: Lens' FunctionConfigurationEnvironment (Maybe Bool) Source #

If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.

functionConfigurationEnvironment_resourceAccessPolicies :: Lens' FunctionConfigurationEnvironment (Maybe [ResourceAccessPolicy]) Source #

A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.

functionConfigurationEnvironment_variables :: Lens' FunctionConfigurationEnvironment (Maybe (HashMap Text Text)) Source #

Environment variables for the Lambda function's configuration.

FunctionDefaultConfig

FunctionDefaultExecutionConfig

FunctionDefinitionVersion

functionDefinitionVersion_defaultConfig :: Lens' FunctionDefinitionVersion (Maybe FunctionDefaultConfig) Source #

The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.

functionDefinitionVersion_functions :: Lens' FunctionDefinitionVersion (Maybe [Function]) Source #

A list of Lambda functions in this function definition version.

FunctionExecutionConfig

FunctionRunAsConfig

functionRunAsConfig_gid :: Lens' FunctionRunAsConfig (Maybe Int) Source #

The group ID whose permissions are used to run a Lambda function.

functionRunAsConfig_uid :: Lens' FunctionRunAsConfig (Maybe Int) Source #

The user ID whose permissions are used to run a Lambda function.

GreengrassLogger

greengrassLogger_space :: Lens' GreengrassLogger (Maybe Int) Source #

The amount of file space, in KB, to use if the local file system is used for logging purposes.

greengrassLogger_type :: Lens' GreengrassLogger LoggerType Source #

The type of log output which will be used.

greengrassLogger_id :: Lens' GreengrassLogger Text Source #

A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

greengrassLogger_component :: Lens' GreengrassLogger LoggerComponent Source #

The component that will be subject to logging.

GroupCertificateAuthorityProperties

GroupInformation

groupInformation_creationTimestamp :: Lens' GroupInformation (Maybe Text) Source #

The time, in milliseconds since the epoch, when the group was created.

groupInformation_lastUpdatedTimestamp :: Lens' GroupInformation (Maybe Text) Source #

The time, in milliseconds since the epoch, when the group was last updated.

groupInformation_latestVersion :: Lens' GroupInformation (Maybe Text) Source #

The ID of the latest version associated with the group.

groupInformation_latestVersionArn :: Lens' GroupInformation (Maybe Text) Source #

The ARN of the latest version associated with the group.

GroupOwnerSetting

groupOwnerSetting_autoAddGroupOwner :: Lens' GroupOwnerSetting (Maybe Bool) Source #

If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.

groupOwnerSetting_groupOwner :: Lens' GroupOwnerSetting (Maybe Text) Source #

The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.

GroupVersion

groupVersion_connectorDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the connector definition version for this group.

groupVersion_coreDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the core definition version for this group.

groupVersion_deviceDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the device definition version for this group.

groupVersion_functionDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the function definition version for this group.

groupVersion_loggerDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the logger definition version for this group.

groupVersion_resourceDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the resource definition version for this group.

groupVersion_subscriptionDefinitionVersionArn :: Lens' GroupVersion (Maybe Text) Source #

The ARN of the subscription definition version for this group.

LocalDeviceResourceData

localDeviceResourceData_sourcePath :: Lens' LocalDeviceResourceData (Maybe Text) Source #

The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.

LocalVolumeResourceData

localVolumeResourceData_destinationPath :: Lens' LocalVolumeResourceData (Maybe Text) Source #

The absolute local path of the resource inside the Lambda environment.

localVolumeResourceData_groupOwnerSetting :: Lens' LocalVolumeResourceData (Maybe GroupOwnerSetting) Source #

Allows you to configure additional group privileges for the Lambda process. This field is optional.

localVolumeResourceData_sourcePath :: Lens' LocalVolumeResourceData (Maybe Text) Source #

The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.

LoggerDefinitionVersion

Resource

resource_resourceDataContainer :: Lens' Resource ResourceDataContainer Source #

A container of data for all resource types.

resource_id :: Lens' Resource Text Source #

The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.

resource_name :: Lens' Resource Text Source #

The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.

ResourceAccessPolicy

resourceAccessPolicy_permission :: Lens' ResourceAccessPolicy (Maybe Permission) Source #

The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).

resourceAccessPolicy_resourceId :: Lens' ResourceAccessPolicy Text Source #

The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)

ResourceDataContainer

resourceDataContainer_secretsManagerSecretResourceData :: Lens' ResourceDataContainer (Maybe SecretsManagerSecretResourceData) Source #

Attributes that define a secret resource, which references a secret from AWS Secrets Manager.

ResourceDefinitionVersion

ResourceDownloadOwnerSetting

resourceDownloadOwnerSetting_groupOwner :: Lens' ResourceDownloadOwnerSetting Text Source #

The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.

resourceDownloadOwnerSetting_groupPermission :: Lens' ResourceDownloadOwnerSetting Permission Source #

The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).

RuntimeConfiguration

S3MachineLearningModelResourceData

s3MachineLearningModelResourceData_destinationPath :: Lens' S3MachineLearningModelResourceData (Maybe Text) Source #

The absolute local path of the resource inside the Lambda environment.

s3MachineLearningModelResourceData_s3Uri :: Lens' S3MachineLearningModelResourceData (Maybe Text) Source #

The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.

SageMakerMachineLearningModelResourceData

sageMakerMachineLearningModelResourceData_destinationPath :: Lens' SageMakerMachineLearningModelResourceData (Maybe Text) Source #

The absolute local path of the resource inside the Lambda environment.

sageMakerMachineLearningModelResourceData_sageMakerJobArn :: Lens' SageMakerMachineLearningModelResourceData (Maybe Text) Source #

The ARN of the Amazon SageMaker training job that represents the source model.

SecretsManagerSecretResourceData

secretsManagerSecretResourceData_arn :: Lens' SecretsManagerSecretResourceData (Maybe Text) Source #

The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default.

secretsManagerSecretResourceData_additionalStagingLabelsToDownload :: Lens' SecretsManagerSecretResourceData (Maybe [Text]) Source #

Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.

Subscription

subscription_target :: Lens' Subscription Text Source #

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

subscription_id :: Lens' Subscription Text Source #

A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

subscription_subject :: Lens' Subscription Text Source #

The MQTT topic used to route the message.

subscription_source :: Lens' Subscription Text Source #

The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

SubscriptionDefinitionVersion

TelemetryConfiguration

telemetryConfiguration_configurationSyncStatus :: Lens' TelemetryConfiguration (Maybe ConfigurationSyncStatus) Source #

Synchronization status of the device reported configuration with the desired configuration.

TelemetryConfigurationUpdate

VersionInformation

versionInformation_creationTimestamp :: Lens' VersionInformation (Maybe Text) Source #

The time, in milliseconds since the epoch, when the version was created.

versionInformation_id :: Lens' VersionInformation (Maybe Text) Source #

The ID of the parent definition that the version is associated with.