Table of Contents
A low-level client representing AWS Greengrass:
import boto3
client = boto3.client('greengrass')
These are the available methods:
Associates a role with a group. Your AWS Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.
See also: AWS API Documentation
Request Syntax
response = client.associate_role_to_group(
GroupId='string',
RoleArn='string'
)
dict
Response Syntax
{
'AssociatedAt': 'string'
}
Response Structure
Associates a role with your account. AWS Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.
See also: AWS API Documentation
Request Syntax
response = client.associate_service_role_to_account(
RoleArn='string'
)
{
'AssociatedAt': 'string'
}
Response Structure
Check if an operation can be paginated.
Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass groups must each contain exactly one AWS Greengrass core.
See also: AWS API Documentation
Request Syntax
response = client.create_core_definition(
AmznClientToken='string',
InitialVersion={
'Cores': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
Name='string'
)
Information about the initial version of the core definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a core definition that has already been defined. AWS Greengrass groups must each contain exactly one AWS Greengrass core.
See also: AWS API Documentation
Request Syntax
response = client.create_core_definition_version(
AmznClientToken='string',
CoreDefinitionId='string',
Cores=[
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
)
A list of cores in the core definition version.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Creates a deployment.
See also: AWS API Documentation
Request Syntax
response = client.create_deployment(
AmznClientToken='string',
DeploymentId='string',
DeploymentType='NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
GroupId='string',
GroupVersionId='string'
)
dict
Response Syntax
{
'DeploymentArn': 'string',
'DeploymentId': 'string'
}
Response Structure
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
response = client.create_device_definition(
AmznClientToken='string',
InitialVersion={
'Devices': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
Name='string'
)
Information about the initial version of the device definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a device definition that has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_device_definition_version(
AmznClientToken='string',
DeviceDefinitionId='string',
Devices=[
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
)
A list of devices in the definition version.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
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
response = client.create_function_definition(
AmznClientToken='string',
InitialVersion={
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
},
Name='string'
)
Information about the initial version of the function definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a Lambda function definition that has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_function_definition_version(
AmznClientToken='string',
FunctionDefinitionId='string',
Functions=[
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
)
A list of Lambda functions in this function definition version.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
response = client.create_group(
AmznClientToken='string',
InitialVersion={
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'ResourceDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
Name='string'
)
Information about the initial version of the group.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a CA for the group. If a CA already exists, it will rotate the existing CA.
See also: AWS API Documentation
Request Syntax
response = client.create_group_certificate_authority(
AmznClientToken='string',
GroupId='string'
)
dict
Response Syntax
{
'GroupCertificateAuthorityArn': 'string'
}
Response Structure
Creates a version of a group which has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_group_version(
AmznClientToken='string',
CoreDefinitionVersionArn='string',
DeviceDefinitionVersionArn='string',
FunctionDefinitionVersionArn='string',
GroupId='string',
LoggerDefinitionVersionArn='string',
ResourceDefinitionVersionArn='string',
SubscriptionDefinitionVersionArn='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
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
response = 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'
)
Information about the initial version of the logger definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a logger definition that has already been defined.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
A list of loggers.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
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
response = 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'
}
}
},
]
},
Name='string'
)
Information about the initial version of the resource definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a resource definition that has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_resource_definition_version(
AmznClientToken='string',
ResourceDefinitionId='string',
Resources=[
{
'Id': 'string',
'Name': 'string',
'ResourceDataContainer': {
'LocalDeviceResourceData': {
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'LocalVolumeResourceData': {
'DestinationPath': 'string',
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'S3MachineLearningModelResourceData': {
'DestinationPath': 'string',
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'SageMakerJobArn': 'string'
}
}
},
]
)
A list of resources.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.
See also: AWS API Documentation
Request Syntax
response = client.create_software_update_job(
AmznClientToken='string',
S3UrlSignerRole='string',
SoftwareToUpdate='core'|'ota_agent',
UpdateAgentLogLevel='NONE'|'TRACE'|'DEBUG'|'VERBOSE'|'INFO'|'WARN'|'ERROR'|'FATAL',
UpdateTargets=[
'string',
],
UpdateTargetsArchitecture='armv7l'|'x86_64'|'aarch64',
UpdateTargetsOperatingSystem='ubuntu'|'raspbian'|'amazon_linux'
)
The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.
dict
Response Syntax
{
'IotJobArn': 'string',
'IotJobId': 'string'
}
Response Structure
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
response = client.create_subscription_definition(
AmznClientToken='string',
InitialVersion={
'Subscriptions': [
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
},
Name='string'
)
Information about the initial version of the subscription definition.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Creates a version of a subscription definition which has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_subscription_definition_version(
AmznClientToken='string',
SubscriptionDefinitionId='string',
Subscriptions=[
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
)
A list of subscriptions.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Deletes a core definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_core_definition(
CoreDefinitionId='string'
)
{}
Response Structure
Deletes a device definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_device_definition(
DeviceDefinitionId='string'
)
{}
Response Structure
Deletes a Lambda function definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_function_definition(
FunctionDefinitionId='string'
)
{}
Response Structure
Deletes a group.
See also: AWS API Documentation
Request Syntax
response = client.delete_group(
GroupId='string'
)
{}
Response Structure
Deletes a logger definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_logger_definition(
LoggerDefinitionId='string'
)
{}
Response Structure
Deletes a resource definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_definition(
ResourceDefinitionId='string'
)
{}
Response Structure
Deletes a subscription definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_subscription_definition(
SubscriptionDefinitionId='string'
)
{}
Response Structure
Disassociates the role from a group.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_role_from_group(
GroupId='string'
)
{
'DisassociatedAt': 'string'
}
Response Structure
Disassociates the service role from your account. Without a service role, deployments will not work.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_service_role_from_account()
{
'DisassociatedAt': 'string'
}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves the role associated with a particular group.
See also: AWS API Documentation
Request Syntax
response = client.get_associated_role(
GroupId='string'
)
{
'AssociatedAt': 'string',
'RoleArn': 'string'
}
Response Structure
Retrieves the connectivity information for a core.
See also: AWS API Documentation
Request Syntax
response = client.get_connectivity_info(
ThingName='string'
)
{
'ConnectivityInfo': [
{
'HostAddress': 'string',
'Id': 'string',
'Metadata': 'string',
'PortNumber': 123
},
],
'Message': 'string'
}
Response Structure
Retrieves information about a core definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_core_definition(
CoreDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a core definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_core_definition_version(
CoreDefinitionId='string',
CoreDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Cores': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Returns the status of a deployment.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment_status(
DeploymentId='string',
GroupId='string'
)
dict
Response Syntax
{
'DeploymentStatus': 'string',
'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
'ErrorDetails': [
{
'DetailedErrorCode': 'string',
'DetailedErrorMessage': 'string'
},
],
'ErrorMessage': 'string',
'UpdatedAt': 'string'
}
Response Structure
Retrieves information about a device definition.
See also: AWS API Documentation
Request Syntax
response = client.get_device_definition(
DeviceDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a device definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_device_definition_version(
DeviceDefinitionId='string',
DeviceDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Devices': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Retrieves information about a Lambda function definition, including its creation time and latest version.
See also: AWS API Documentation
Request Syntax
response = client.get_function_definition(
FunctionDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
See also: AWS API Documentation
Request Syntax
response = client.get_function_definition_version(
FunctionDefinitionId='string',
FunctionDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123
},
'Id': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Retrieves information about a group.
See also: AWS API Documentation
Request Syntax
response = client.get_group(
GroupId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retreives the CA associated with a group. Returns the public key of the CA.
See also: AWS API Documentation
Request Syntax
response = client.get_group_certificate_authority(
CertificateAuthorityId='string',
GroupId='string'
)
dict
Response Syntax
{
'GroupCertificateAuthorityArn': 'string',
'GroupCertificateAuthorityId': 'string',
'PemEncodedCertificate': 'string'
}
Response Structure
Retrieves the current configuration for the CA used by the group.
See also: AWS API Documentation
Request Syntax
response = client.get_group_certificate_configuration(
GroupId='string'
)
{
'CertificateAuthorityExpiryInMilliseconds': 'string',
'CertificateExpiryInMilliseconds': 'string',
'GroupId': 'string'
}
Response Structure
Retrieves information about a group version.
See also: AWS API Documentation
Request Syntax
response = client.get_group_version(
GroupId='string',
GroupVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'ResourceDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Retrieves information about a logger definition.
See also: AWS API Documentation
Request Syntax
response = client.get_logger_definition(
LoggerDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a logger definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_logger_definition_version(
LoggerDefinitionId='string',
LoggerDefinitionVersionId='string'
)
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
Create a paginator for an operation.
Retrieves information about a resource definition, including its creation time and latest version.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_definition(
ResourceDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a resource definition version, including which resources are included in the version.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_definition_version(
ResourceDefinitionId='string',
ResourceDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Resources': [
{
'Id': 'string',
'Name': 'string',
'ResourceDataContainer': {
'LocalDeviceResourceData': {
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'LocalVolumeResourceData': {
'DestinationPath': 'string',
'GroupOwnerSetting': {
'AutoAddGroupOwner': True|False,
'GroupOwner': 'string'
},
'SourcePath': 'string'
},
'S3MachineLearningModelResourceData': {
'DestinationPath': 'string',
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'SageMakerJobArn': 'string'
}
}
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Retrieves the service role that is attached to your account.
See also: AWS API Documentation
Request Syntax
response = client.get_service_role_for_account()
{
'AssociatedAt': 'string',
'RoleArn': 'string'
}
Response Structure
Retrieves information about a subscription definition.
See also: AWS API Documentation
Request Syntax
response = client.get_subscription_definition(
SubscriptionDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Retrieves information about a subscription definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_subscription_definition_version(
SubscriptionDefinitionId='string',
SubscriptionDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Subscriptions': [
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Returns an object that can wait for some condition.
Lists the versions of a core definition.
See also: AWS API Documentation
Request Syntax
response = client.list_core_definition_versions(
CoreDefinitionId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of core definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_core_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Returns a history of deployments for the group.
See also: AWS API Documentation
Request Syntax
response = client.list_deployments(
GroupId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Deployments': [
{
'CreatedAt': 'string',
'DeploymentArn': 'string',
'DeploymentId': 'string',
'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
'GroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the versions of a device definition.
See also: AWS API Documentation
Request Syntax
response = client.list_device_definition_versions(
DeviceDefinitionId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of device definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_device_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the versions of a Lambda function definition.
See also: AWS API Documentation
Request Syntax
response = client.list_function_definition_versions(
FunctionDefinitionId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of Lambda function definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_function_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Retrieves the current CAs for a group.
See also: AWS API Documentation
Request Syntax
response = client.list_group_certificate_authorities(
GroupId='string'
)
{
'GroupCertificateAuthorities': [
{
'GroupCertificateAuthorityArn': 'string',
'GroupCertificateAuthorityId': 'string'
},
]
}
Response Structure
Lists the versions of a group.
See also: AWS API Documentation
Request Syntax
response = client.list_group_versions(
GroupId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of groups.
See also: AWS API Documentation
Request Syntax
response = client.list_groups(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Groups': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the versions of a logger definition.
See also: AWS API Documentation
Request Syntax
response = client.list_logger_definition_versions(
LoggerDefinitionId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of logger definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_logger_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the versions of a resource definition.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_definition_versions(
MaxResults='string',
NextToken='string',
ResourceDefinitionId='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of resource definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the versions of a subscription definition.
See also: AWS API Documentation
Request Syntax
response = client.list_subscription_definition_versions(
MaxResults='string',
NextToken='string',
SubscriptionDefinitionId='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Retrieves a list of subscription definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_subscription_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Resets a group's deployments.
See also: AWS API Documentation
Request Syntax
response = client.reset_deployments(
AmznClientToken='string',
Force=True|False,
GroupId='string'
)
dict
Response Syntax
{
'DeploymentArn': 'string',
'DeploymentId': 'string'
}
Response Structure
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
response = client.update_connectivity_info(
ConnectivityInfo=[
{
'HostAddress': 'string',
'Id': 'string',
'Metadata': 'string',
'PortNumber': 123
},
],
ThingName='string'
)
A list of connectivity info.
dict
Response Syntax
{
'Message': 'string',
'Version': 'string'
}
Response Structure
Updates a core definition.
See also: AWS API Documentation
Request Syntax
response = client.update_core_definition(
CoreDefinitionId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates a device definition.
See also: AWS API Documentation
Request Syntax
response = client.update_device_definition(
DeviceDefinitionId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates a Lambda function definition.
See also: AWS API Documentation
Request Syntax
response = client.update_function_definition(
FunctionDefinitionId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates a group.
See also: AWS API Documentation
Request Syntax
response = client.update_group(
GroupId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates the Certificate expiry time for a group.
See also: AWS API Documentation
Request Syntax
response = client.update_group_certificate_configuration(
CertificateExpiryInMilliseconds='string',
GroupId='string'
)
dict
Response Syntax
{
'CertificateAuthorityExpiryInMilliseconds': 'string',
'CertificateExpiryInMilliseconds': 'string',
'GroupId': 'string'
}
Response Structure
Updates a logger definition.
See also: AWS API Documentation
Request Syntax
response = client.update_logger_definition(
LoggerDefinitionId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates a resource definition.
See also: AWS API Documentation
Request Syntax
response = client.update_resource_definition(
Name='string',
ResourceDefinitionId='string'
)
dict
Response Syntax
{}
Response Structure
Updates a subscription definition.
See also: AWS API Documentation
Request Syntax
response = client.update_subscription_definition(
Name='string',
SubscriptionDefinitionId='string'
)
dict
Response Syntax
{}
Response Structure