2019/03/29 - AWS Greengrass - 3 new 25 updated api methods
Changes Greengrass APIs now support tagging operations on resources
Remove tags with specified keys from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED] A list of the keys to remove from the resource tags.
(string) --
None
Retrieves the tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) -- A map of the key-value pairs for the resource tag.
(string) --
(string) --
Add tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the resource.
dict
[REQUIRED] A map of the key-value pairs for the resource tag.
(string) --
(string) --
None
{'tags': {'string': 'string'}}
Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
client.create_connector_definition(
AmznClientToken='string',
InitialVersion={
'Connectors': [
{
'ConnectorArn': 'string',
'Id': 'string',
'Parameters': {
'string': 'string'
}
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the connector definition.
Connectors (list) -- A list of references to connectors in this version, with their corresponding configuration settings.
(dict) -- Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
ConnectorArn (string) -- The ARN of the connector.
Id (string) -- 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:_-]+.
Parameters (dict) -- The parameters or configuration that the connector uses.
(string) --
(string) --
string
The name of the connector 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_core_definition(
AmznClientToken='string',
InitialVersion={
'Cores': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the core definition.
Cores (list) -- A list of cores in the core definition version.
(dict) -- Information about a core.
CertificateArn (string) -- The ARN of the certificate associated with the core.
Id (string) -- 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:_-]+''.
SyncShadow (boolean) -- If true, the core's local shadow is automatically synced with the cloud.
ThingArn (string) -- The ARN of the thing which is the core.
string
The name of the core 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
client.create_device_definition(
AmznClientToken='string',
InitialVersion={
'Devices': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the device definition.
Devices (list) -- A list of devices in the definition version.
(dict) -- Information about a device.
CertificateArn (string) -- The ARN of the certificate associated with the device.
Id (string) -- 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:_-]+''.
SyncShadow (boolean) -- If true, the device's local shadow will be automatically synced with the cloud.
ThingArn (string) -- The thing ARN of the device.
string
The name of the device 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_function_definition(
AmznClientToken='string',
InitialVersion={
'DefaultConfig': {
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
}
},
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
},
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the function definition.
DefaultConfig (dict) -- The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
Execution (dict) -- Configuration information that specifies how a Lambda function runs.
IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
Functions (list) -- A list of Lambda functions in this function definition version.
(dict) -- Information about a Lambda function.
FunctionArn (string) -- The ARN of the Lambda function.
FunctionConfiguration (dict) -- The configuration of the Lambda function.
EncodingType (string) -- The expected encoding type of the input payload for the function. The default is ''json''.
Environment (dict) -- The environment configuration of the function.
AccessSysfs (boolean) -- 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.
Execution (dict) -- Configuration related to executing the Lambda function
IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
ResourceAccessPolicies (list) -- 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.
(dict) -- A policy used by the function to access a resource.
Permission (string) -- The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).
ResourceId (string) -- The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
Variables (dict) -- Environment variables for the Lambda function's configuration.
(string) --
(string) --
ExecArgs (string) -- The execution arguments.
Executable (string) -- The name of the function executable.
MemorySize (integer) -- 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.
Pinned (boolean) -- True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
Timeout (integer) -- The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
Id (string) -- 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:_-]+''.
string
The name of the function 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_group(
AmznClientToken='string',
InitialVersion={
'ConnectorDefinitionVersionArn': 'string',
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'ResourceDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the group.
ConnectorDefinitionVersionArn (string) -- The ARN of the connector definition version for this group.
CoreDefinitionVersionArn (string) -- The ARN of the core definition version for this group.
DeviceDefinitionVersionArn (string) -- The ARN of the device definition version for this group.
FunctionDefinitionVersionArn (string) -- The ARN of the function definition version for this group.
LoggerDefinitionVersionArn (string) -- The ARN of the logger definition version for this group.
ResourceDefinitionVersionArn (string) -- The ARN of the resource definition version for this group.
SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.
string
The name of the group.
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) -- Success. The group was created.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
client.create_logger_definition(
AmznClientToken='string',
InitialVersion={
'Loggers': [
{
'Component': 'GreengrassSystem'|'Lambda',
'Id': 'string',
'Level': 'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'Space': 123,
'Type': 'FileSystem'|'AWSCloudWatch'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the logger definition.
Loggers (list) -- A list of loggers.
(dict) -- Information about a logger
Component (string) -- The component that will be subject to logging.
Id (string) -- 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:_-]+''.
Level (string) -- The level of the logs.
Space (integer) -- The amount of file space, in KB, to use if the local file system is used for logging purposes.
Type (string) -- The type of log output which will be used.
string
The name of the logger 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
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',
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'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) -- 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.
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.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
client.create_subscription_definition(
AmznClientToken='string',
InitialVersion={
'Subscriptions': [
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
dict
Information about the initial version of the subscription definition.
Subscriptions (list) -- A list of subscriptions.
(dict) -- Information about a subscription.
Id (string) -- 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:_-]+''.
Source (string) -- 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'.
Subject (string) -- The MQTT topic used to route the message.
Target (string) -- 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'.
string
The name of the subscription 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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
{'tags': {'string': 'string'}}
Returns the status of a bulk deployment.
See also: AWS API Documentation
Request Syntax
client.get_bulk_deployment_status(
BulkDeploymentId='string'
)
string
[REQUIRED] The ID of the bulk deployment.
dict
Response Syntax
{
'BulkDeploymentMetrics': {
'InvalidInputRecords': 123,
'RecordsProcessed': 123,
'RetryAttempts': 123
},
'BulkDeploymentStatus': 'Initializing'|'Running'|'Completed'|'Stopping'|'Stopped'|'Failed',
'CreatedAt': 'string',
'ErrorDetails': [
{
'DetailedErrorCode': 'string',
'DetailedErrorMessage': 'string'
},
],
'ErrorMessage': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Success. The response body contains the status of the bulk deployment.
BulkDeploymentMetrics (dict) -- Relevant metrics on input records processed during bulk deployment.
InvalidInputRecords (integer) -- 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.
RecordsProcessed (integer) -- The total number of group records from the input file that have been processed so far, or attempted.
RetryAttempts (integer) -- 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.
BulkDeploymentStatus (string) -- The status of the bulk deployment.
CreatedAt (string) -- The time, in ISO format, when the deployment was created.
ErrorDetails (list) -- Error details
(dict) -- Details about the error.
DetailedErrorCode (string) -- A detailed error code.
DetailedErrorMessage (string) -- A detailed error message.
ErrorMessage (string) -- Error message
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a connector definition.
See also: AWS API Documentation
Request Syntax
client.get_connector_definition(
ConnectorDefinitionId='string'
)
string
[REQUIRED] The ID of the connector definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': '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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a core definition version.
See also: AWS API Documentation
Request Syntax
client.get_core_definition(
CoreDefinitionId='string'
)
string
[REQUIRED] The ID of the core definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': '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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a device definition.
See also: AWS API Documentation
Request Syntax
client.get_device_definition(
DeviceDefinitionId='string'
)
string
[REQUIRED] The ID of the device definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': '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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a Lambda function definition, including its creation time and latest version.
See also: AWS API Documentation
Request Syntax
client.get_function_definition(
FunctionDefinitionId='string'
)
string
[REQUIRED] The ID of the Lambda function definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) -- success
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a group.
See also: AWS API Documentation
Request Syntax
client.get_group(
GroupId='string'
)
string
[REQUIRED] The ID of the Greengrass group.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) -- success
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a logger definition.
See also: AWS API Documentation
Request Syntax
client.get_logger_definition(
LoggerDefinitionId='string'
)
string
[REQUIRED] The ID of the logger definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': '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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a resource definition, including its creation time and latest version.
See also: AWS API Documentation
Request Syntax
client.get_resource_definition(
ResourceDefinitionId='string'
)
string
[REQUIRED] The ID of the resource definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) -- success
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'tags': {'string': 'string'}}
Retrieves information about a subscription definition.
See also: AWS API Documentation
Request Syntax
client.get_subscription_definition(
SubscriptionDefinitionId='string'
)
string
[REQUIRED] The ID of the subscription definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': '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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
tags (dict) -- The tags for the definition.
(string) --
(string) --
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of connector definitions.
See also: AWS API Documentation
Request Syntax
client.list_connector_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of core definitions.
See also: AWS API Documentation
Request Syntax
client.list_core_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of device definitions.
See also: AWS API Documentation
Request Syntax
client.list_device_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of Lambda function definitions.
See also: AWS API Documentation
Request Syntax
client.list_function_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- Success. The response contains the IDs of all the Greengrass Lambda function definitions in this account.
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of logger definitions.
See also: AWS API Documentation
Request Syntax
client.list_logger_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of resource definitions.
See also: AWS API Documentation
Request Syntax
client.list_resource_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- The IDs of all the Greengrass resource definitions in this account.
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'Definitions': {'Tags': {'string': 'string'}}}
Retrieves a list of subscription definitions.
See also: AWS API Documentation
Request Syntax
client.list_subscription_definitions(
MaxResults='string',
NextToken='string'
)
string
The maximum number of results to be returned per request.
string
The token for the next set of results, or ''null'' if there are no additional results.
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Information about a definition.
(dict) -- Information about a definition.
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 latest version of the definition.
LatestVersionArn (string) -- The ARN of the latest version of the definition.
Name (string) -- The name of the definition.
Tags (dict) -- The tags for the definition.
(string) --
(string) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
{'tags': {'string': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.start_bulk_deployment(
AmznClientToken='string',
ExecutionRoleArn='string',
InputFileUri='string',
tags={
'string': 'string'
}
)
string
A client token used to correlate requests and responses.
string
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.
string
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.
dict
Tag(s) to add to the new resource
(string) --
(string) --
dict
Response Syntax
{
'BulkDeploymentArn': 'string',
'BulkDeploymentId': 'string'
}
Response Structure
(dict) -- success
BulkDeploymentArn (string) -- The ARN of the bulk deployment.
BulkDeploymentId (string) -- The ID of the bulk deployment.