Table of Contents
Greengrass.
Client
¶A low-level client representing AWS Greengrass AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.:
import boto3
client = boto3.client('greengrass')
These are the available methods:
associate_role_to_group()
associate_service_role_to_account()
can_paginate()
close()
create_connector_definition()
create_connector_definition_version()
create_core_definition()
create_core_definition_version()
create_deployment()
create_device_definition()
create_device_definition_version()
create_function_definition()
create_function_definition_version()
create_group()
create_group_certificate_authority()
create_group_version()
create_logger_definition()
create_logger_definition_version()
create_resource_definition()
create_resource_definition_version()
create_software_update_job()
create_subscription_definition()
create_subscription_definition_version()
delete_connector_definition()
delete_core_definition()
delete_device_definition()
delete_function_definition()
delete_group()
delete_logger_definition()
delete_resource_definition()
delete_subscription_definition()
disassociate_role_from_group()
disassociate_service_role_from_account()
get_associated_role()
get_bulk_deployment_status()
get_connectivity_info()
get_connector_definition()
get_connector_definition_version()
get_core_definition()
get_core_definition_version()
get_deployment_status()
get_device_definition()
get_device_definition_version()
get_function_definition()
get_function_definition_version()
get_group()
get_group_certificate_authority()
get_group_certificate_configuration()
get_group_version()
get_logger_definition()
get_logger_definition_version()
get_paginator()
get_resource_definition()
get_resource_definition_version()
get_service_role_for_account()
get_subscription_definition()
get_subscription_definition_version()
get_thing_runtime_configuration()
get_waiter()
list_bulk_deployment_detailed_reports()
list_bulk_deployments()
list_connector_definition_versions()
list_connector_definitions()
list_core_definition_versions()
list_core_definitions()
list_deployments()
list_device_definition_versions()
list_device_definitions()
list_function_definition_versions()
list_function_definitions()
list_group_certificate_authorities()
list_group_versions()
list_groups()
list_logger_definition_versions()
list_logger_definitions()
list_resource_definition_versions()
list_resource_definitions()
list_subscription_definition_versions()
list_subscription_definitions()
list_tags_for_resource()
reset_deployments()
start_bulk_deployment()
stop_bulk_deployment()
tag_resource()
untag_resource()
update_connectivity_info()
update_connector_definition()
update_core_definition()
update_device_definition()
update_function_definition()
update_group()
update_group_certificate_configuration()
update_logger_definition()
update_resource_definition()
update_subscription_definition()
update_thing_runtime_configuration()
associate_role_to_group
(**kwargs)¶Associates a role with a group. Your 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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
associate_service_role_to_account
(**kwargs)¶Associates a role with your account. AWS IoT 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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
create_connector_definition
(**kwargs)¶Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
See also: AWS API Documentation
Request Syntax
response = client.create_connector_definition(
AmznClientToken='string',
InitialVersion={
'Connectors': [
{
'ConnectorArn': 'string',
'Id': 'string',
'Parameters': {
'string': 'string'
}
},
]
},
Name='string',
tags={
'string': 'string'
}
)
Information about the initial version of the connector definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_connector_definition_version
(**kwargs)¶Creates a version of a connector definition which has already been defined.
See also: AWS API Documentation
Request Syntax
response = client.create_connector_definition_version(
AmznClientToken='string',
ConnectorDefinitionId='string',
Connectors=[
{
'ConnectorArn': 'string',
'Id': 'string',
'Parameters': {
'string': 'string'
}
},
]
)
A list of references to connectors in this version, with their corresponding configuration settings.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_core_definition
(**kwargs)¶Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.
See also: AWS API Documentation
Request Syntax
response = client.create_core_definition(
AmznClientToken='string',
InitialVersion={
'Cores': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
Information about the initial version of the core definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_core_definition_version
(**kwargs)¶Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one 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
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_deployment
(**kwargs)¶Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.
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
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_device_definition
(**kwargs)¶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',
tags={
'string': 'string'
}
)
Information about the initial version of the device definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_device_definition_version
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_function_definition
(**kwargs)¶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={
'DefaultConfig': {
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
}
},
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
},
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123,
'FunctionRuntimeOverride': 'string'
},
'Id': 'string'
},
]
},
Name='string',
tags={
'string': 'string'
}
)
Information about the initial version of the function definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_function_definition_version
(**kwargs)¶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',
DefaultConfig={
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
}
},
FunctionDefinitionId='string',
Functions=[
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
},
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123,
'FunctionRuntimeOverride': 'string'
},
'Id': 'string'
},
]
)
The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
A list of Lambda functions in this function definition version.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_group
(**kwargs)¶Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.
See also: AWS API Documentation
Request Syntax
response = client.create_group(
AmznClientToken='string',
InitialVersion={
'ConnectorDefinitionVersionArn': 'string',
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'ResourceDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
Name='string',
tags={
'string': 'string'
}
)
Information about the initial version of the group.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
create_group_version
(**kwargs)¶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',
ConnectorDefinitionVersionArn='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
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_logger_definition
(**kwargs)¶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',
tags={
'string': 'string'
}
)
Information about the initial version of the logger definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_logger_definition_version
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_resource_definition
(**kwargs)¶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',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
},
Name='string',
tags={
'string': 'string'
}
)
Information about the initial version of the resource definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_resource_definition_version
(**kwargs)¶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',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
)
A list of resources.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_software_update_job
(**kwargs)¶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='armv6l'|'armv7l'|'x86_64'|'aarch64',
UpdateTargetsOperatingSystem='ubuntu'|'raspbian'|'amazon_linux'|'openwrt'
)
[REQUIRED] 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',
'PlatformSoftwareVersion': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
create_subscription_definition
(**kwargs)¶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',
tags={
'string': 'string'
}
)
Information about the initial version of the subscription definition.
Tag(s) to add to the new resource.
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
create_subscription_definition_version
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_connector_definition
(**kwargs)¶Deletes a connector definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_connector_definition(
ConnectorDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_core_definition
(**kwargs)¶Deletes a core definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_core_definition(
CoreDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_device_definition
(**kwargs)¶Deletes a device definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_device_definition(
DeviceDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_function_definition
(**kwargs)¶Deletes a Lambda function definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_function_definition(
FunctionDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_group
(**kwargs)¶Deletes a group.
See also: AWS API Documentation
Request Syntax
response = client.delete_group(
GroupId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_logger_definition
(**kwargs)¶Deletes a logger definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_logger_definition(
LoggerDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_resource_definition
(**kwargs)¶Deletes a resource definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_definition(
ResourceDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
delete_subscription_definition
(**kwargs)¶Deletes a subscription definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_subscription_definition(
SubscriptionDefinitionId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
disassociate_role_from_group
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
disassociate_service_role_from_account
()¶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
Exceptions
Greengrass.Client.exceptions.InternalServerErrorException
get_associated_role
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
get_bulk_deployment_status
(**kwargs)¶Returns the status of a bulk deployment.
See also: AWS API Documentation
Request Syntax
response = client.get_bulk_deployment_status(
BulkDeploymentId='string'
)
{
'BulkDeploymentMetrics': {
'InvalidInputRecords': 123,
'RecordsProcessed': 123,
'RetryAttempts': 123
},
'BulkDeploymentStatus': 'Initializing'|'Running'|'Completed'|'Stopping'|'Stopped'|'Failed',
'CreatedAt': 'string',
'ErrorDetails': [
{
'DetailedErrorCode': 'string',
'DetailedErrorMessage': 'string'
},
],
'ErrorMessage': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_connectivity_info
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
get_connector_definition
(**kwargs)¶Retrieves information about a connector definition.
See also: AWS API Documentation
Request Syntax
response = client.get_connector_definition(
ConnectorDefinitionId='string'
)
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_connector_definition_version
(**kwargs)¶Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.
See also: AWS API Documentation
Request Syntax
response = client.get_connector_definition_version(
ConnectorDefinitionId='string',
ConnectorDefinitionVersionId='string',
NextToken='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Connectors': [
{
'ConnectorArn': 'string',
'Id': 'string',
'Parameters': {
'string': 'string'
}
},
]
},
'Id': 'string',
'NextToken': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_core_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_core_definition_version
(**kwargs)¶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',
'NextToken': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_deployment_status
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_device_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_device_definition_version
(**kwargs)¶Retrieves information about a device definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_device_definition_version(
DeviceDefinitionId='string',
DeviceDefinitionVersionId='string',
NextToken='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Devices': [
{
'CertificateArn': 'string',
'Id': 'string',
'SyncShadow': True|False,
'ThingArn': 'string'
},
]
},
'Id': 'string',
'NextToken': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_function_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_function_definition_version
(**kwargs)¶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',
NextToken='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'DefaultConfig': {
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
}
},
'Functions': [
{
'FunctionArn': 'string',
'FunctionConfiguration': {
'EncodingType': 'binary'|'json',
'Environment': {
'AccessSysfs': True|False,
'Execution': {
'IsolationMode': 'GreengrassContainer'|'NoContainer',
'RunAs': {
'Gid': 123,
'Uid': 123
}
},
'ResourceAccessPolicies': [
{
'Permission': 'ro'|'rw',
'ResourceId': 'string'
},
],
'Variables': {
'string': 'string'
}
},
'ExecArgs': 'string',
'Executable': 'string',
'MemorySize': 123,
'Pinned': True|False,
'Timeout': 123,
'FunctionRuntimeOverride': 'string'
},
'Id': 'string'
},
]
},
'Id': 'string',
'NextToken': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_group
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
get_group_certificate_configuration
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
get_group_version
(**kwargs)¶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': {
'ConnectorDefinitionVersionArn': 'string',
'CoreDefinitionVersionArn': 'string',
'DeviceDefinitionVersionArn': 'string',
'FunctionDefinitionVersionArn': 'string',
'LoggerDefinitionVersionArn': 'string',
'ResourceDefinitionVersionArn': 'string',
'SubscriptionDefinitionVersionArn': 'string'
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_logger_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_logger_definition_version
(**kwargs)¶Retrieves information about a logger definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_logger_definition_version(
LoggerDefinitionId='string',
LoggerDefinitionVersionId='string',
NextToken='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
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_resource_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_resource_definition_version
(**kwargs)¶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',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'S3Uri': 'string'
},
'SageMakerMachineLearningModelResourceData': {
'DestinationPath': 'string',
'OwnerSetting': {
'GroupOwner': 'string',
'GroupPermission': 'ro'|'rw'
},
'SageMakerJobArn': 'string'
},
'SecretsManagerSecretResourceData': {
'ARN': 'string',
'AdditionalStagingLabelsToDownload': [
'string',
]
}
}
},
]
},
'Id': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_service_role_for_account
()¶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
Exceptions
Greengrass.Client.exceptions.InternalServerErrorException
get_subscription_definition
(**kwargs)¶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',
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_subscription_definition_version
(**kwargs)¶Retrieves information about a subscription definition version.
See also: AWS API Documentation
Request Syntax
response = client.get_subscription_definition_version(
NextToken='string',
SubscriptionDefinitionId='string',
SubscriptionDefinitionVersionId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Definition': {
'Subscriptions': [
{
'Id': 'string',
'Source': 'string',
'Subject': 'string',
'Target': 'string'
},
]
},
'Id': 'string',
'NextToken': 'string',
'Version': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
get_thing_runtime_configuration
(**kwargs)¶Get the runtime configuration of a thing.
See also: AWS API Documentation
Request Syntax
response = client.get_thing_runtime_configuration(
ThingName='string'
)
{
'RuntimeConfiguration': {
'TelemetryConfiguration': {
'ConfigurationSyncStatus': 'InSync'|'OutOfSync',
'Telemetry': 'On'|'Off'
}
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_bulk_deployment_detailed_reports
(**kwargs)¶Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
See also: AWS API Documentation
Request Syntax
response = client.list_bulk_deployment_detailed_reports(
BulkDeploymentId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Deployments': [
{
'CreatedAt': 'string',
'DeploymentArn': 'string',
'DeploymentId': 'string',
'DeploymentStatus': 'string',
'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
'ErrorDetails': [
{
'DetailedErrorCode': 'string',
'DetailedErrorMessage': 'string'
},
],
'ErrorMessage': 'string',
'GroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_bulk_deployments
(**kwargs)¶Returns a list of bulk deployments.
See also: AWS API Documentation
Request Syntax
response = client.list_bulk_deployments(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'BulkDeployments': [
{
'BulkDeploymentArn': 'string',
'BulkDeploymentId': 'string',
'CreatedAt': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_connector_definition_versions
(**kwargs)¶Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
See also: AWS API Documentation
Request Syntax
response = client.list_connector_definition_versions(
ConnectorDefinitionId='string',
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_connector_definitions
(**kwargs)¶Retrieves a list of connector definitions.
See also: AWS API Documentation
Request Syntax
response = client.list_connector_definitions(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
list_core_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_core_definitions
(**kwargs)¶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',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
list_deployments
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_device_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_device_definitions
(**kwargs)¶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',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
list_function_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_function_definitions
(**kwargs)¶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',
'Tags': {
'string': '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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
list_group_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_groups
(**kwargs)¶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
list_logger_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_logger_definitions
(**kwargs)¶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',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
list_resource_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_resource_definitions
(**kwargs)¶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',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
list_subscription_definition_versions
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
list_subscription_definitions
(**kwargs)¶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',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Retrieves a list of resource tags for a resource arn.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
{
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
reset_deployments
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
start_bulk_deployment
(**kwargs)¶Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.
See also: AWS API Documentation
Request Syntax
response = client.start_bulk_deployment(
AmznClientToken='string',
ExecutionRoleArn='string',
InputFileUri='string',
tags={
'string': 'string'
}
)
Tag(s) to add to the new resource.
dict
Response Syntax
{
'BulkDeploymentArn': 'string',
'BulkDeploymentId': 'string'
}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
stop_bulk_deployment
(**kwargs)¶Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.
See also: AWS API Documentation
Request Syntax
response = client.stop_bulk_deployment(
BulkDeploymentId='string'
)
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
tag_resource
(**kwargs)¶Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
tags={
'string': 'string'
}
)
The key-value pair for the resource tag.
None
Exceptions
Greengrass.Client.exceptions.BadRequestException
untag_resource
(**kwargs)¶Remove resource tags from a Greengrass Resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED] An array of tag keys to delete
None
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_connectivity_info
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
update_connector_definition
(**kwargs)¶Updates a connector definition.
See also: AWS API Documentation
Request Syntax
response = client.update_connector_definition(
ConnectorDefinitionId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_core_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_device_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_function_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_group
(**kwargs)¶Updates a group.
See also: AWS API Documentation
Request Syntax
response = client.update_group(
GroupId='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_group_certificate_configuration
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
update_logger_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_resource_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_subscription_definition
(**kwargs)¶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
Exceptions
Greengrass.Client.exceptions.BadRequestException
update_thing_runtime_configuration
(**kwargs)¶Updates the runtime configuration of a thing.
See also: AWS API Documentation
Request Syntax
response = client.update_thing_runtime_configuration(
TelemetryConfiguration={
'Telemetry': 'On'|'Off'
},
ThingName='string'
)
Configuration for telemetry service.
dict
Response Syntax
{}
Response Structure
Exceptions
Greengrass.Client.exceptions.BadRequestException
Greengrass.Client.exceptions.InternalServerErrorException
The available paginators are:
Greengrass.Paginator.ListBulkDeploymentDetailedReports
Greengrass.Paginator.ListBulkDeployments
Greengrass.Paginator.ListConnectorDefinitionVersions
Greengrass.Paginator.ListConnectorDefinitions
Greengrass.Paginator.ListCoreDefinitionVersions
Greengrass.Paginator.ListCoreDefinitions
Greengrass.Paginator.ListDeployments
Greengrass.Paginator.ListDeviceDefinitionVersions
Greengrass.Paginator.ListDeviceDefinitions
Greengrass.Paginator.ListFunctionDefinitionVersions
Greengrass.Paginator.ListFunctionDefinitions
Greengrass.Paginator.ListGroupVersions
Greengrass.Paginator.ListGroups
Greengrass.Paginator.ListLoggerDefinitionVersions
Greengrass.Paginator.ListLoggerDefinitions
Greengrass.Paginator.ListResourceDefinitionVersions
Greengrass.Paginator.ListResourceDefinitions
Greengrass.Paginator.ListSubscriptionDefinitionVersions
Greengrass.Paginator.ListSubscriptionDefinitions
Greengrass.Paginator.
ListBulkDeploymentDetailedReports
¶paginator = client.get_paginator('list_bulk_deployment_detailed_reports')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_bulk_deployment_detailed_reports()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
BulkDeploymentId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Deployments': [
{
'CreatedAt': 'string',
'DeploymentArn': 'string',
'DeploymentId': 'string',
'DeploymentStatus': 'string',
'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
'ErrorDetails': [
{
'DetailedErrorCode': 'string',
'DetailedErrorMessage': 'string'
},
],
'ErrorMessage': 'string',
'GroupArn': 'string'
},
],
}
Response Structure
Greengrass.Paginator.
ListBulkDeployments
¶paginator = client.get_paginator('list_bulk_deployments')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_bulk_deployments()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'BulkDeployments': [
{
'BulkDeploymentArn': 'string',
'BulkDeploymentId': 'string',
'CreatedAt': 'string'
},
],
}
Response Structure
Greengrass.Paginator.
ListConnectorDefinitionVersions
¶paginator = client.get_paginator('list_connector_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_connector_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConnectorDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListConnectorDefinitions
¶paginator = client.get_paginator('list_connector_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_connector_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListCoreDefinitionVersions
¶paginator = client.get_paginator('list_core_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_core_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CoreDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListCoreDefinitions
¶paginator = client.get_paginator('list_core_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_core_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListDeployments
¶paginator = client.get_paginator('list_deployments')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_deployments()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GroupId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Deployments': [
{
'CreatedAt': 'string',
'DeploymentArn': 'string',
'DeploymentId': 'string',
'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
'GroupArn': 'string'
},
],
}
Response Structure
Greengrass.Paginator.
ListDeviceDefinitionVersions
¶paginator = client.get_paginator('list_device_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_device_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DeviceDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListDeviceDefinitions
¶paginator = client.get_paginator('list_device_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_device_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListFunctionDefinitionVersions
¶paginator = client.get_paginator('list_function_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_function_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FunctionDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListFunctionDefinitions
¶paginator = client.get_paginator('list_function_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_function_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListGroupVersions
¶paginator = client.get_paginator('list_group_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_group_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GroupId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListGroups
¶paginator = client.get_paginator('list_groups')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_groups()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Groups': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string'
},
],
}
Response Structure
Greengrass.Paginator.
ListLoggerDefinitionVersions
¶paginator = client.get_paginator('list_logger_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_logger_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LoggerDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListLoggerDefinitions
¶paginator = client.get_paginator('list_logger_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_logger_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListResourceDefinitionVersions
¶paginator = client.get_paginator('list_resource_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_resource_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListResourceDefinitions
¶paginator = client.get_paginator('list_resource_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_resource_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Greengrass.Paginator.
ListSubscriptionDefinitionVersions
¶paginator = client.get_paginator('list_subscription_definition_versions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_subscription_definition_versions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubscriptionDefinitionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Versions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'Version': 'string'
},
]
}
Response Structure
Greengrass.Paginator.
ListSubscriptionDefinitions
¶paginator = client.get_paginator('list_subscription_definitions')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Greengrass.Client.list_subscription_definitions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'Definitions': [
{
'Arn': 'string',
'CreationTimestamp': 'string',
'Id': 'string',
'LastUpdatedTimestamp': 'string',
'LatestVersion': 'string',
'LatestVersionArn': 'string',
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure