2017/06/07 - AWS Greengrass - 64 new api methods
Changes AWS Greengrass is software that lets you run local compute, messaging, and device state synchronization for connected devices in a secure way. With AWS Greengrass, connected devices can run AWS Lambda functions, keep device data in sync, and communicate with other devices securely even when not connected to the Internet. Using AWS Lambda, Greengrass ensures your IoT devices can respond quickly to local events, operate with intermittent connections, and minimize the cost of transmitting IoT data to the cloud.
Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.
See also: AWS API Documentation
Request Syntax
client.delete_function_definition(
FunctionDefinitionId='string'
)
string
[REQUIRED] the unique Id of the lambda definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.
See also: AWS API Documentation
Request Syntax
client.associate_role_to_group(
GroupId='string',
RoleArn='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
Role arn you wish to associate with this group.
dict
Response Syntax
{
'AssociatedAt': 'string'
}
Response Structure
(dict) -- 200 response
AssociatedAt (string) -- Time the role arn was associated to your group.
Updates a device definition.
See also: AWS API Documentation
Request Syntax
client.update_device_definition(
DeviceDefinitionId='string',
Name='string'
)
string
[REQUIRED] device definition Id
string
name of the definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Updates a subscription definition.
See also: AWS API Documentation
Request Syntax
client.update_subscription_definition(
Name='string',
SubscriptionDefinitionId='string'
)
string
name of the definition
string
[REQUIRED] subscription definition Id
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Creates a core definition. You may optionally provide the initial version of the core definition or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.
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'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
Cores (list) -- Cores in the definition version.
(dict) -- Information on the core
CertificateArn (string) -- Certificate arn of the core.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the core.
string
name of the core definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
client.create_group(
AmznClientToken='string',
InitialVersion={
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
Name='string'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
CoreDefinitionVersionArn (string) -- Core definition version arn for this group.
DeviceDefinitionVersionArn (string) -- Device definition version arn for this group.
FunctionDefinitionVersionArn (string) -- Function definition version arn for this group.
LoggerDefinitionVersionArn (string) -- Logger definitionv ersion arn for this group.
SubscriptionDefinitionVersionArn (string) -- Subscription definition version arn for this group.
string
name of the group
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) -- Group created successfully
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Returns a history of deployments for the group.
See also: AWS API Documentation
Request Syntax
client.list_deployments(
GroupId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Deployments': [
{
'CreatedAt': 'string',
'DeploymentArn': 'string',
'DeploymentId': 'string',
'GroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- The response body contains the list of deployments for the given group Id
Deployments (list) -- Information on deployments
(dict) -- Information on the deployment
CreatedAt (string) -- Timestamp when the deployment was created.
DeploymentArn (string) -- Arn of the deployment.
DeploymentId (string) -- Id of the deployment.
GroupArn (string) -- Arn of the group for this deployment.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Retrieves information about a group version.
See also: AWS API Documentation
Request Syntax
client.get_group_version(
GroupId='string',
GroupVersionId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
[REQUIRED] Group version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- 200 response
Arn (string) -- Arn of the group version.
CreationTimestamp (string) -- Timestamp when the group version was created.
Definition (dict) -- Information on the definition
CoreDefinitionVersionArn (string) -- Core definition version arn for this group.
DeviceDefinitionVersionArn (string) -- Device definition version arn for this group.
FunctionDefinitionVersionArn (string) -- Function definition version arn for this group.
LoggerDefinitionVersionArn (string) -- Logger definitionv ersion arn for this group.
SubscriptionDefinitionVersionArn (string) -- Subscription definition version arn for this group.
Id (string) -- Id of the group version.
Version (string) -- Unique Id for a version of the Group.
Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy AWSGreengrassResourceAccessRolePolicy
See also: AWS API Documentation
Request Syntax
client.associate_service_role_to_account(
RoleArn='string'
)
string
Role arn you wish to associate with this account.
dict
Response Syntax
{
'AssociatedAt': 'string'
}
Response Structure
(dict) -- 200 response
AssociatedAt (string) -- Time when the service role was associated to the account.
Retrieves information about a core definition version.
See also: AWS API Documentation
Request Syntax
client.get_core_definition(
CoreDefinitionId='string'
)
string
[REQUIRED] core definition Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Deletes a group. The group must not have been used in deployment.
See also: AWS API Documentation
Request Syntax
client.delete_group(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Deletes a device definition. The device definition must not have been used in a deployment.
See also: AWS API Documentation
Request Syntax
client.delete_device_definition(
DeviceDefinitionId='string'
)
string
[REQUIRED] device definition Id
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Deletes a core definition. The core definition must not have been used in a deployment.
See also: AWS API Documentation
Request Syntax
client.delete_core_definition(
CoreDefinitionId='string'
)
string
[REQUIRED] core definition Id
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Lists the versions of a Lambda function definition.
See also: AWS API Documentation
Request Syntax
client.list_function_definition_versions(
FunctionDefinitionId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] the unique Id of the lambda definition
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) -- 200 response
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Lists the versions of a logger definition.
See also: AWS API Documentation
Request Syntax
client.list_logger_definition_versions(
LoggerDefinitionId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] logger definition Id
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Lists the versions of a subscription definition.
See also: AWS API Documentation
Request Syntax
client.list_subscription_definition_versions(
MaxResults='string',
NextToken='string',
SubscriptionDefinitionId='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
string
[REQUIRED] subscription definition Id
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Retrieves the connectivity information for a core.
See also: AWS API Documentation
Request Syntax
client.get_connectivity_info(
ThingName='string'
)
string
[REQUIRED] Thing Name
dict
Response Syntax
{
'ConnectivityInfo': [
{
'HostAddress': 'string',
'Id': 'string',
'Metadata': 'string',
'PortNumber': 123
},
],
'Message': 'string'
}
Response Structure
(dict) -- 200 response
ConnectivityInfo (list) -- Connectivity info array
(dict) -- Connectivity Info
HostAddress (string) -- Endpoint for the GGC. Can be an IP address or DNS.
Id (string) -- Element Id for this entry in the list.
Metadata (string) -- Metadata for this endpoint.
PortNumber (integer) -- Port of the GGC. Usually 8883.
Message (string) -- Response Text
Updates a Lambda function definition.
See also: AWS API Documentation
Request Syntax
client.update_function_definition(
FunctionDefinitionId='string',
Name='string'
)
string
[REQUIRED] the unique Id of the lambda definition
string
name of the definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Retrieves a list of device definitions.
See also: AWS API Documentation
Request Syntax
client.list_device_definitions(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Definitions
(dict) -- Information on the Definition
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Lists the versions of a device definition.
See also: AWS API Documentation
Request Syntax
client.list_device_definition_versions(
DeviceDefinitionId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] device definition Id
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Creates a logger definition. You may optionally provide the initial version of the logger definition 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'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
Loggers (list) -- List of loggers.
(dict) -- Information on the Logger
Component (string) -- The component that will be subject to logs
Id (string) -- Element Id for this entry in the list.
Level (string) -- The level of the logs
Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
Type (string) -- The type which will be use for log output
string
name of the logger definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retreives the CA associated with a group. Returns the public key of the CA.
See also: AWS API Documentation
Request Syntax
client.get_group_certificate_authority(
CertificateAuthorityId='string',
GroupId='string'
)
string
[REQUIRED] certificate authority Id
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'GroupCertificateAuthorityArn': 'string',
'GroupCertificateAuthorityId': 'string',
'PemEncodedCertificate': 'string'
}
Response Structure
(dict) -- The response body contains the PKI Configuration
GroupCertificateAuthorityArn (string) -- Arn of the certificate authority for the group.
GroupCertificateAuthorityId (string) -- Id of the certificate authority for the group.
PemEncodedCertificate (string) -- PEM encoded certificate for the group.
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={
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'Environment': {
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
},
Name='string'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
Functions (list) -- Lambda functions in this function definition version.
(dict) -- Information on function
FunctionArn (string) -- Arn of the Lambda function.
FunctionConfiguration (dict) -- Configuration of the function
Environment (dict) -- Environment of the function configuration
Variables (dict) -- Environment variables for the lambda function.
(string) --
(string) --
ExecArgs (string) -- Execution Arguments
Executable (string) -- Executable
MemorySize (integer) -- The memory size, in KB, you configured for the function.
Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
Id (string) -- Id of the function in this version.
string
name of the function definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Updates a core definition.
See also: AWS API Documentation
Request Syntax
client.update_core_definition(
CoreDefinitionId='string',
Name='string'
)
string
[REQUIRED] core definition Id
string
name of the definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Creates a version of a logger definition that has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_logger_definition_version(
AmznClientToken='string',
LoggerDefinitionId='string',
Loggers=[
{
'Component': 'GreengrassSystem'|'Lambda',
'Id': 'string',
'Level': 'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'Space': 123,
'Type': 'FileSystem'|'AWSCloudWatch'
},
]
)
string
The client token used to request idempotent operations.
string
[REQUIRED] logger definition Id
list
List of loggers.
(dict) -- Information on the Logger
Component (string) -- The component that will be subject to logs
Id (string) -- Element Id for this entry in the list.
Level (string) -- The level of the logs
Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
Type (string) -- The type which will be use for log output
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Retrieves information about a logger definition.
See also: AWS API Documentation
Request Syntax
client.get_logger_definition(
LoggerDefinitionId='string'
)
string
[REQUIRED] logger definition Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves information about a device definition version.
See also: AWS API Documentation
Request Syntax
client.get_device_definition_version(
DeviceDefinitionId='string',
DeviceDefinitionVersionId='string'
)
string
[REQUIRED] device definition Id
string
[REQUIRED] device definition version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Devices': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the device definition version.
CreationTimestamp (string) -- Timestamp of when the device definition version was created.
Definition (dict) -- Device definition version
Devices (list) -- Devices in the definition version.
(dict) -- Information on a Device
CertificateArn (string) -- Certificate arn of the device.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the device.
Id (string) -- Id of the device definition the version belongs to.
Version (string) -- Version of the device definition version.
List the versions of a group.
See also: AWS API Documentation
Request Syntax
client.list_group_versions(
GroupId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) -- the list of versions and metadata for the given group Id
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Updates a group.
See also: AWS API Documentation
Request Syntax
client.update_group(
GroupId='string',
Name='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
name of the definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Retrieves information about a device definition.
See also: AWS API Documentation
Request Syntax
client.get_device_definition(
DeviceDefinitionId='string'
)
string
[REQUIRED] device definition Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Creates a CA for the group. If a CA already exists, it will rotate the existing CA.
See also: AWS API Documentation
Request Syntax
client.create_group_certificate_authority(
AmznClientToken='string',
GroupId='string'
)
string
The client token used to request idempotent operations.
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'GroupCertificateAuthorityArn': 'string'
}
Response Structure
(dict) -- The response body contains the new active CA ARN
GroupCertificateAuthorityArn (string) -- Arn of the group certificate authority.
Disassociates the role from a group.
See also: AWS API Documentation
Request Syntax
client.disassociate_role_from_group(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'DisassociatedAt': 'string'
}
Response Structure
(dict) -- 200 response
DisassociatedAt (string) -- Time when the role was disassociated from the group.
Retrieves information about a subscription definition.
See also: AWS API Documentation
Request Syntax
client.get_subscription_definition(
SubscriptionDefinitionId='string'
)
string
[REQUIRED] subscription definition Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves a list of core definitions.
See also: AWS API Documentation
Request Syntax
client.list_core_definitions(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Definitions
(dict) -- Information on the Definition
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Retrieves the current CAs for a group.
See also: AWS API Documentation
Request Syntax
client.list_group_certificate_authorities(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'GroupCertificateAuthorities': [
{
'GroupCertificateAuthorityArn': 'string',
'GroupCertificateAuthorityId': 'string'
},
]
}
Response Structure
(dict) -- The response body contains the PKI Configuration
GroupCertificateAuthorities (list) -- List of certificate authorities associated with the group.
(dict) -- Information on group certificate authority properties
GroupCertificateAuthorityArn (string) -- Arn of the certificate authority for the group.
GroupCertificateAuthorityId (string) -- Id of the certificate authority for the group.
Creates a device definition. You may optinally provide the initial version of the device definition 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'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
Devices (list) -- Devices in the definition version.
(dict) -- Information on a Device
CertificateArn (string) -- Certificate arn of the device.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the device.
string
name of the device definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves the role associated with a particular group.
See also: AWS API Documentation
Request Syntax
client.get_associated_role(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'AssociatedAt': 'string',
'RoleArn': 'string'
}
Response Structure
(dict) -- 200 response
AssociatedAt (string) -- Time when the role was associated for the group.
RoleArn (string) -- Arn of the role that is associated with the group.
Retrieves information about a Lambda function definition, such as its creation time and latest version.
See also: AWS API Documentation
Request Syntax
client.get_function_definition(
FunctionDefinitionId='string'
)
string
[REQUIRED] the unique Id of the lambda definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) -- 200 response
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves information about a logger definition version.
See also: AWS API Documentation
Request Syntax
client.get_logger_definition_version(
LoggerDefinitionId='string',
LoggerDefinitionVersionId='string'
)
string
[REQUIRED] logger definition Id
string
[REQUIRED] logger definition version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Loggers': [
{
'Component': 'GreengrassSystem'|'Lambda',
'Id': 'string',
'Level': 'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'Space': 123,
'Type': 'FileSystem'|'AWSCloudWatch'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- test
Arn (string) -- Arn of the logger definition version.
CreationTimestamp (string) -- Timestamp of when the logger definition version was created.
Definition (dict) -- Information on definition
Loggers (list) -- List of loggers.
(dict) -- Information on the Logger
Component (string) -- The component that will be subject to logs
Id (string) -- Element Id for this entry in the list.
Level (string) -- The level of the logs
Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
Type (string) -- The type which will be use for log output
Id (string) -- Id of the logger definition the version belongs to.
Version (string) -- Version of the logger definition version.
Retrieves a list of logger definitions.
See also: AWS API Documentation
Request Syntax
client.list_logger_definitions(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Definitions
(dict) -- Information on the Definition
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Create a version of a Lambda function definition that has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_function_definition_version(
AmznClientToken='string',
FunctionDefinitionId='string',
Functions=[
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'Environment': {
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
)
string
The client token used to request idempotent operations.
string
[REQUIRED] the unique Id of the lambda definition
list
Lambda functions in this function definition version.
(dict) -- Information on function
FunctionArn (string) -- Arn of the Lambda function.
FunctionConfiguration (dict) -- Configuration of the function
Environment (dict) -- Environment of the function configuration
Variables (dict) -- Environment variables for the lambda function.
(string) --
(string) --
ExecArgs (string) -- Execution Arguments
Executable (string) -- Executable
MemorySize (integer) -- The memory size, in KB, you configured for the function.
Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
Id (string) -- Id of the function in this version.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Creates a version of a group which has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_group_version(
AmznClientToken='string',
CoreDefinitionVersionArn='string',
DeviceDefinitionVersionArn='string',
FunctionDefinitionVersionArn='string',
GroupId='string',
LoggerDefinitionVersionArn='string',
SubscriptionDefinitionVersionArn='string'
)
string
The client token used to request idempotent operations.
string
Core definition version arn for this group.
string
Device definition version arn for this group.
string
Function definition version arn for this group.
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
Logger definitionv ersion arn for this group.
string
Subscription definition version arn for this group.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- the requested version of the Group
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Retrieves the current configuration for the CA used by the group.
See also: AWS API Documentation
Request Syntax
client.get_group_certificate_configuration(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'CertificateAuthorityExpiryInMilliseconds': 'string',
'CertificateExpiryInMilliseconds': 'string',
'GroupId': 'string'
}
Response Structure
(dict) -- The response body contains the PKI Configuration
CertificateAuthorityExpiryInMilliseconds (string) -- Amount of time when the certificate authority expires in milliseconds.
CertificateExpiryInMilliseconds (string) -- Amount of time when the certificate expires in milliseconds.
GroupId (string) -- Id of the group the certificate configuration belongs to.
Returns the status of a deployment.
See also: AWS API Documentation
Request Syntax
client.get_deployment_status(
DeploymentId='string',
GroupId='string'
)
string
[REQUIRED] the deployment Id
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'DeploymentStatus': 'string',
'ErrorMessage': 'string',
'UpdatedAt': 'string'
}
Response Structure
(dict) -- The response body contains the status of a deployment for a group.
DeploymentStatus (string) -- Status of the deployment.
ErrorMessage (string) -- Error Message
UpdatedAt (string) -- Last time the deployment status was updated.
Deletes a subscription definition. The subscription definition must not have been used in a deployment.
See also: AWS API Documentation
Request Syntax
client.delete_subscription_definition(
SubscriptionDefinitionId='string'
)
string
[REQUIRED] subscription definition Id
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Retrieves information about a core definition version.
See also: AWS API Documentation
Request Syntax
client.get_core_definition_version(
CoreDefinitionId='string',
CoreDefinitionVersionId='string'
)
string
[REQUIRED] core definition Id
string
[REQUIRED] core definition version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Cores': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- 200 response
Arn (string) -- Arn of the core definition version.
CreationTimestamp (string) -- Timestamp of when the core definition version was created.
Definition (dict) -- Information on definition
Cores (list) -- Cores in the definition version.
(dict) -- Information on the core
CertificateArn (string) -- Certificate arn of the core.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the core.
Id (string) -- Id of the core definition the version belongs to.
Version (string) -- Version of the core definition version.
Deletes a logger definition. The logger definition must not have been used in a deployment.
See also: AWS API Documentation
Request Syntax
client.delete_logger_definition(
LoggerDefinitionId='string'
)
string
[REQUIRED] logger definition Id
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.
See also: AWS API Documentation
Request Syntax
client.get_function_definition_version(
FunctionDefinitionId='string',
FunctionDefinitionVersionId='string'
)
string
[REQUIRED] the unique Id of the lambda definition
string
[REQUIRED] Function definition version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'Environment': {
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) -- 200 response
Arn (string) -- Arn of the function definition version.
CreationTimestamp (string) -- Timestamp when the funtion definition version was created.
Definition (dict) -- Information on the function definition version
Functions (list) -- Lambda functions in this function definition version.
(dict) -- Information on function
FunctionArn (string) -- Arn of the Lambda function.
FunctionConfiguration (dict) -- Configuration of the function
Environment (dict) -- Environment of the function configuration
Variables (dict) -- Environment variables for the lambda function.
(string) --
(string) --
ExecArgs (string) -- Execution Arguments
Executable (string) -- Executable
MemorySize (integer) -- The memory size, in KB, you configured for the function.
Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
Id (string) -- Id of the function in this version.
Id (string) -- Id of the function definition the version belongs to.
Version (string) -- Version of the function definition version.
Retrieves information about a group.
See also: AWS API Documentation
Request Syntax
client.get_group(
GroupId='string'
)
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) -- the requested Group
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves a list of groups.
See also: AWS API Documentation
Request Syntax
client.list_groups(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Groups': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Groups (list) -- Groups
(dict) -- Information of a group
Arn (string) -- Arn of a group.
CreationTimestamp (string) -- Timestamp of when the group was created.
Id (string) -- Id of a group.
LastUpdatedTimestamp (string) -- Last updated timestamp of the group.
LatestVersion (string) -- Last version of the group.
LatestVersionArn (string) -- Latest version arn of the group.
Name (string) -- Name of a group.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Retrieves a list of subscription definitions.
See also: AWS API Documentation
Request Syntax
client.list_subscription_definitions(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Definitions (list) -- Definitions
(dict) -- Information on the Definition
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Lists versions of a core definition.
See also: AWS API Documentation
Request Syntax
client.list_core_definition_versions(
CoreDefinitionId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED] core definition Id
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Versions (list) -- Versions
(dict) -- Information on the version
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Updates the Cert expiry time for a group.
See also: AWS API Documentation
Request Syntax
client.update_group_certificate_configuration(
CertificateExpiryInMilliseconds='string',
GroupId='string'
)
string
Amount of time when the certificate expires in milliseconds.
string
[REQUIRED] The unique Id of the AWS Greengrass Group
dict
Response Syntax
{
'CertificateAuthorityExpiryInMilliseconds': 'string',
'CertificateExpiryInMilliseconds': 'string',
'GroupId': 'string'
}
Response Structure
(dict) -- The response body contains the PKI Configuration
CertificateAuthorityExpiryInMilliseconds (string) -- Amount of time when the certificate authority expires in milliseconds.
CertificateExpiryInMilliseconds (string) -- Amount of time when the certificate expires in milliseconds.
GroupId (string) -- Id of the group the certificate configuration belongs to.
Updates a logger definition.
See also: AWS API Documentation
Request Syntax
client.update_logger_definition(
LoggerDefinitionId='string',
Name='string'
)
string
[REQUIRED] logger definition Id
string
name of the definition
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.
See also: AWS API Documentation
Request Syntax
client.update_connectivity_info(
ConnectivityInfo=[
{
'HostAddress': 'string',
'Id': 'string',
'Metadata': 'string',
'PortNumber': 123
},
],
ThingName='string'
)
list
Connectivity info array
(dict) -- Connectivity Info
HostAddress (string) -- Endpoint for the GGC. Can be an IP address or DNS.
Id (string) -- Element Id for this entry in the list.
Metadata (string) -- Metadata for this endpoint.
PortNumber (integer) -- Port of the GGC. Usually 8883.
string
[REQUIRED] Thing Name
dict
Response Syntax
{
'Message': 'string',
'Version': 'string'
}
Response Structure
(dict) -- 200 response
Message (string) -- Response Text
Version (string) -- New Version
Retrieves information about a subscription definition version.
See also: AWS API Documentation
Request Syntax
client.get_subscription_definition_version(
SubscriptionDefinitionId='string',
SubscriptionDefinitionVersionId='string'
)
string
[REQUIRED] subscription definition Id
string
[REQUIRED] subscription definition version Id
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Subscriptions': [
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the subscription definition version.
CreationTimestamp (string) -- Timestamp of when the subscription definition version was created.
Definition (dict) -- Information on the definition
Subscriptions (list) -- Subscriptions in the version.
(dict) -- Information on subscription
Id (string) -- Element Id for this entry in the list.
Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
Subject (string) -- Subject of the message.
Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
Id (string) -- Id of the subscription definition the version belongs to.
Version (string) -- Version of the subscription definition version.
Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.
See also: AWS API Documentation
Request Syntax
client.create_core_definition_version(
AmznClientToken='string',
CoreDefinitionId='string',
Cores=[
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
)
string
The client token used to request idempotent operations.
string
[REQUIRED] core definition Id
list
Cores in the definition version.
(dict) -- Information on the core
CertificateArn (string) -- Certificate arn of the core.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the core.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Creates a deployment.
See also: AWS API Documentation
Request Syntax
client.create_deployment(
AmznClientToken='string',
DeploymentId='string',
DeploymentType='NewDeployment'|'Redeployment',
GroupId='string',
GroupVersionId='string'
)
string
The client token used to request idempotent operations.
string
Id of the deployment if you wish to redeploy a previous deployment.
string
Type of deployment
string
[REQUIRED] The unique Id of the AWS Greengrass Group
string
Group Version you wish to deploy.
dict
Response Syntax
{
'DeploymentArn': 'string',
'DeploymentId': 'string'
}
Response Structure
(dict) -- Successfully deployed the given group
DeploymentArn (string) -- Arn of the deployment.
DeploymentId (string) -- Id of the deployment.
Creates a version of a device definition that has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_device_definition_version(
AmznClientToken='string',
DeviceDefinitionId='string',
Devices=[
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
)
string
The client token used to request idempotent operations.
string
[REQUIRED] device definition Id
list
Devices in the definition version.
(dict) -- Information on a Device
CertificateArn (string) -- Certificate arn of the device.
Id (string) -- Element Id for this entry in the list.
SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
ThingArn (string) -- Thing arn of the device.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Creates a version of a subscription definition which has already been defined.
See also: AWS API Documentation
Request Syntax
client.create_subscription_definition_version(
AmznClientToken='string',
SubscriptionDefinitionId='string',
Subscriptions=[
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
)
string
The client token used to request idempotent operations.
string
[REQUIRED] subscription definition Id
list
Subscriptions in the version.
(dict) -- Information on subscription
Id (string) -- Element Id for this entry in the list.
Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
Subject (string) -- Subject of the message.
Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the version.
CreationTimestamp (string) -- Timestamp of when the version was created.
Id (string) -- Id of the resource container.
Version (string) -- Unique Id of a version.
Creates a subscription definition. You may optionally provide the initial version of the subscription definition 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'
)
string
The client token used to request idempotent operations.
dict
Information on the initial version
Subscriptions (list) -- Subscriptions in the version.
(dict) -- Information on subscription
Id (string) -- Element Id for this entry in the list.
Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
Subject (string) -- Subject of the message.
Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
string
name of the subscription definition
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
Retrieves a list of Lambda function definitions.
See also: AWS API Documentation
Request Syntax
client.list_function_definitions(
MaxResults='string',
NextToken='string'
)
string
Specifies the maximum number of list results to be returned in this page
string
Specifies the pagination token used when iterating through a paginated request
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- The Ids of all the Greengrass Function Definitions in this account.
Definitions (list) -- Definitions
(dict) -- Information on the Definition
Arn (string) -- Arn of the definition.
CreationTimestamp (string) -- Timestamp of when the definition was created.
Id (string) -- Id of the definition.
LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
LatestVersion (string) -- Last version of the definition.
LatestVersionArn (string) -- Latest version arn of the definition.
Name (string) -- Name of the definition.
NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
Retrieves the service role that is attached to the account.
See also: AWS API Documentation
Request Syntax
client.get_service_role_for_account()
dict
Response Syntax
{
'AssociatedAt': 'string',
'RoleArn': 'string'
}
Response Structure
(dict) -- 200 response
AssociatedAt (string) -- Time when the service role was associated to the account.
RoleArn (string) -- Role arn which is associated to the account.
Disassociates the service role from the account. Without a service role, deployments will not work.
See also: AWS API Documentation
Request Syntax
client.disassociate_service_role_from_account()
dict
Response Syntax
{
'DisassociatedAt': 'string'
}
Response Structure
(dict) -- 200 response
DisassociatedAt (string) -- Time when the service role was disassociated from the account.