2019/11/25 - AWS Greengrass - 4 updated api methods
Changes IoT Greengrass supports machine learning resources in 'No container' mode.
{'InitialVersion': {'Resources': {'ResourceDataContainer': {'S3MachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}},
'SageMakerMachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_resource_definition(
AmznClientToken='string',
InitialVersion={
'Resources': [
{
'Id': 'string',
'Name': 'string',
'ResourceDataContainer': {
'LocalDeviceResourceData': {
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'LocalVolumeResourceData': {
'DestinationPath': 'string',
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'S3MachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the resource definition.
Resources (list) -- A list of resources.
(dict) -- Information about a resource.
Id (string) -- [REQUIRED] 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.
Name (string) -- [REQUIRED] 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.
ResourceDataContainer (dict) -- [REQUIRED] A container of data for all resource types.
LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- 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 (dict) -- Attributes that define the local volume resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- [REQUIRED] 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.
GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- [REQUIRED] 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.
GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
ARN (string) -- 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.
AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
(string) --
string
The name of the resource definition.
dict
Tag(s) to add to the new resource.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- The ARN of the definition.
CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
Id (string) -- The ID of the definition.
LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
LatestVersion (string) -- The ID of the latest version associated with the definition.
LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
Name (string) -- The name of the definition.
{'Resources': {'ResourceDataContainer': {'S3MachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}},
'SageMakerMachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}}}}}
Creates a version of a resource definition that has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_resource_definition_version(
AmznClientToken='string',
ResourceDefinitionId='string',
Resources=[
{
'Id': 'string',
'Name': 'string',
'ResourceDataContainer': {
'LocalDeviceResourceData': {
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'LocalVolumeResourceData': {
'DestinationPath': 'string',
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'S3MachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
)
string
A client token used to correlate requests and responses.
string
[REQUIRED] The ID of the resource definition.
list
A list of resources.
(dict) -- Information about a resource.
Id (string) -- [REQUIRED] 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.
Name (string) -- [REQUIRED] 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.
ResourceDataContainer (dict) -- [REQUIRED] A container of data for all resource types.
LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- 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 (dict) -- Attributes that define the local volume resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- [REQUIRED] 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.
GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- [REQUIRED] 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.
GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
ARN (string) -- 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.
AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- The ARN of the version.
CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
Id (string) -- The ID of the parent definition that the version is associated with.
Version (string) -- The ID of the version.
{'UpdateTargetsOperatingSystem': ['openwrt']}
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.
See also: AWS API Documentation
Request Syntax
client.create_software_update_job(
AmznClientToken='string',
S3UrlSignerRole='string',
SoftwareToUpdate='core'|'ota_agent',
UpdateAgentLogLevel='NONE'|'TRACE'|'DEBUG'|'VERBOSE'|'INFO'|'WARN'|'ERROR'|'FATAL',
UpdateTargets=[
'string',
],
UpdateTargetsArchitecture='armv6l'|'armv7l'|'x86_64'|'aarch64',
UpdateTargetsOperatingSystem='ubuntu'|'raspbian'|'amazon_linux'|'openwrt'
)
string
A client token used to correlate requests and responses.
string
[REQUIRED] The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
string
[REQUIRED] The piece of software on the Greengrass core that will be updated.
string
The minimum level of log statements that should be logged by the OTA Agent during an update.
list
[REQUIRED] The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.
(string) --
string
[REQUIRED] The architecture of the cores which are the targets of an update.
string
[REQUIRED] The operating system of the cores which are the targets of an update.
dict
Response Syntax
{
'IotJobArn': 'string',
'IotJobId': 'string',
'PlatformSoftwareVersion': 'string'
}
Response Structure
(dict) -- success
IotJobArn (string) -- The IoT Job ARN corresponding to this update.
IotJobId (string) -- The IoT Job Id corresponding to this update.
PlatformSoftwareVersion (string) -- The software version installed on the device or devices after the update.
{'Definition': {'Resources': {'ResourceDataContainer': {'S3MachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}},
'SageMakerMachineLearningModelResourceData': {'OwnerSetting': {'GroupOwner': 'string',
'GroupPermission': 'ro '
'| '
'rw'}}}}}}
Retrieves information about a resource definition version, including which resources are included in the version.
See also: AWS API Documentation
Request Syntax
client.get_resource_definition_version(
ResourceDefinitionId='string',
ResourceDefinitionVersionId='string'
)
string
[REQUIRED] The ID of the resource definition.
string
[REQUIRED] 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.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Resources': [
{
'Id': 'string',
'Name': 'string',
'ResourceDataContainer': {
'LocalDeviceResourceData': {
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'LocalVolumeResourceData': {
'DestinationPath': 'string',
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'S3MachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- success
Arn (string) -- Arn of the resource definition version.
CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the resource definition version was created.
Definition (dict) -- Information about the definition.
Resources (list) -- A list of resources.
(dict) -- Information about a resource.
Id (string) -- 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.
Name (string) -- 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.
ResourceDataContainer (dict) -- A container of data for all resource types.
LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- 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 (dict) -- Attributes that define the local volume resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
AutoAddGroupOwner (boolean) -- 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.
GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- 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.
GroupPermission (string) -- The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
GroupOwner (string) -- 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.
GroupPermission (string) -- The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
ARN (string) -- 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.
AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
(string) --
Id (string) -- The ID of the resource definition version.
Version (string) -- The version of the resource definition version.