Greengrass

Table of Contents

• Greengrass
  • Client
  • Paginators

Client

class 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'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• RoleArn (string) -- [REQUIRED] The ARN of the role you wish to associate with this group. The existence of the role is not validated.

Return type

dict

Returns

Response Syntax

{
    'AssociatedAt': 'string'
}

Response Structure

• (dict) -- success
  • AssociatedAt (string) -- The time, in milliseconds since the epoch, when the role ARN was associated with the group.

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'
)

Parameters

RoleArn (string) -- [REQUIRED] The ARN of the service role you wish to associate with your account.

Return type

dict

Returns

Response Syntax

{
    'AssociatedAt': 'string'
}

Response Structure

• (dict) -- success
  • AssociatedAt (string) -- The time when the service role was associated with the account.

Exceptions

• Greengrass.Client.exceptions.BadRequestException
• Greengrass.Client.exceptions.InternalServerErrorException

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").

Returns

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the connector definition.

  • Connectors (list) -- A list of references to connectors in this version, with their corresponding configuration settings.
    • (dict) -- Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
      • ConnectorArn (string) -- [REQUIRED] The ARN of the connector.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.
      • Parameters (dict) -- The parameters or configuration that the connector uses.
        • (string) --
          • (string) --
• Name (string) -- The name of the connector definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
            }
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.
• Connectors (list) --

  A list of references to connectors in this version, with their corresponding configuration settings.

  • (dict) -- Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
    • ConnectorArn (string) -- [REQUIRED] The ARN of the connector.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.
    • Parameters (dict) -- The parameters or configuration that the connector uses.
      • (string) --
        • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the core definition.

  • Cores (list) -- A list of cores in the core definition version.
    • (dict) -- Information about a core.
      • CertificateArn (string) -- [REQUIRED] The ARN of the certificate associated with the core.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
      • SyncShadow (boolean) -- If true, the core's local shadow is automatically synced with the cloud.
      • ThingArn (string) -- [REQUIRED] The ARN of the thing which is the core.
• Name (string) -- The name of the core definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.
• Cores (list) --

  A list of cores in the core definition version.

  • (dict) -- Information about a core.
    • CertificateArn (string) -- [REQUIRED] The ARN of the certificate associated with the core.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
    • SyncShadow (boolean) -- If true, the core's local shadow is automatically synced with the cloud.
    • ThingArn (string) -- [REQUIRED] The ARN of the thing which is the core.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• DeploymentId (string) -- The ID of the deployment if you wish to redeploy a previous deployment.
• DeploymentType (string) -- [REQUIRED] The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• GroupVersionId (string) -- The ID of the group version to be deployed.

Return type

dict

Returns

Response Syntax

{
    'DeploymentArn': 'string',
    'DeploymentId': 'string'
}

Response Structure

• (dict) -- Success. The group was deployed.
  • DeploymentArn (string) -- The ARN of the deployment.
  • DeploymentId (string) -- The ID of the deployment.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the device definition.

  • Devices (list) -- A list of devices in the definition version.
    • (dict) -- Information about a device.
      • CertificateArn (string) -- [REQUIRED] The ARN of the certificate associated with the device.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
      • SyncShadow (boolean) -- If true, the device's local shadow will be automatically synced with the cloud.
      • ThingArn (string) -- [REQUIRED] The thing ARN of the device.
• Name (string) -- The name of the device definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• Devices (list) --

  A list of devices in the definition version.

  • (dict) -- Information about a device.
    • CertificateArn (string) -- [REQUIRED] The ARN of the certificate associated with the device.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
    • SyncShadow (boolean) -- If true, the device's local shadow will be automatically synced with the cloud.
    • ThingArn (string) -- [REQUIRED] The thing ARN of the device.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the function definition.

  • DefaultConfig (dict) -- The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
    • Execution (dict) -- Configuration information that specifies how a Lambda function runs.
      • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
      • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
        • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
        • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
  • Functions (list) -- A list of Lambda functions in this function definition version.
    • (dict) -- Information about a Lambda function.
      • FunctionArn (string) -- The ARN of the Lambda function.
      • FunctionConfiguration (dict) -- The configuration of the Lambda function.
        • EncodingType (string) -- The expected encoding type of the input payload for the function. The default is ''json''.
        • Environment (dict) -- The environment configuration of the function.
          • AccessSysfs (boolean) -- If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
          • Execution (dict) -- Configuration related to executing the Lambda function
            • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
            • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
              • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
              • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
          • ResourceAccessPolicies (list) -- A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.
            • (dict) -- A policy used by the function to access a resource.
              • Permission (string) -- The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).
              • ResourceId (string) -- [REQUIRED] The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
          • Variables (dict) -- Environment variables for the Lambda function's configuration.
            • (string) --
              • (string) --
        • ExecArgs (string) -- The execution arguments.
        • Executable (string) -- The name of the function executable.
        • MemorySize (integer) -- The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.
        • Pinned (boolean) -- True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
        • Timeout (integer) -- The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
        • FunctionRuntimeOverride (string) -- The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
• Name (string) -- The name of the function definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• DefaultConfig (dict) --

  The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.

  • Execution (dict) -- Configuration information that specifies how a Lambda function runs.
    • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
    • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
      • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
      • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
• FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.
• Functions (list) --

  A list of Lambda functions in this function definition version.

  • (dict) -- Information about a Lambda function.
    • FunctionArn (string) -- The ARN of the Lambda function.
    • FunctionConfiguration (dict) -- The configuration of the Lambda function.
      • EncodingType (string) -- The expected encoding type of the input payload for the function. The default is ''json''.
      • Environment (dict) -- The environment configuration of the function.
        • AccessSysfs (boolean) -- If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
        • Execution (dict) -- Configuration related to executing the Lambda function
          • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
          • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
            • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
            • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
        • ResourceAccessPolicies (list) -- A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.
          • (dict) -- A policy used by the function to access a resource.
            • Permission (string) -- The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).
            • ResourceId (string) -- [REQUIRED] The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
        • Variables (dict) -- Environment variables for the Lambda function's configuration.
          • (string) --
            • (string) --
      • ExecArgs (string) -- The execution arguments.
      • Executable (string) -- The name of the function executable.
      • MemorySize (integer) -- The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.
      • Pinned (boolean) -- True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
      • Timeout (integer) -- The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
      • FunctionRuntimeOverride (string) -- The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the group.

  • ConnectorDefinitionVersionArn (string) -- The ARN of the connector definition version for this group.
  • CoreDefinitionVersionArn (string) -- The ARN of the core definition version for this group.
  • DeviceDefinitionVersionArn (string) -- The ARN of the device definition version for this group.
  • FunctionDefinitionVersionArn (string) -- The ARN of the function definition version for this group.
  • LoggerDefinitionVersionArn (string) -- The ARN of the logger definition version for this group.
  • ResourceDefinitionVersionArn (string) -- The ARN of the resource definition version for this group.
  • SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.
• Name (string) -- [REQUIRED] The name of the group.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) -- Success. The group was created.
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

Exceptions

• Greengrass.Client.exceptions.BadRequestException

create_group_certificate_authority(**kwargs)

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'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'GroupCertificateAuthorityArn': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the new active CA ARN.
  • GroupCertificateAuthorityArn (string) -- The ARN of the group certificate authority.

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'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• ConnectorDefinitionVersionArn (string) -- The ARN of the connector definition version for this group.
• CoreDefinitionVersionArn (string) -- The ARN of the core definition version for this group.
• DeviceDefinitionVersionArn (string) -- The ARN of the device definition version for this group.
• FunctionDefinitionVersionArn (string) -- The ARN of the function definition version for this group.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• LoggerDefinitionVersionArn (string) -- The ARN of the logger definition version for this group.
• ResourceDefinitionVersionArn (string) -- The ARN of the resource definition version for this group.
• SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) -- Success. The response contains information about the group version.
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the logger definition.

  • Loggers (list) -- A list of loggers.
    • (dict) -- Information about a logger
      • Component (string) -- [REQUIRED] The component that will be subject to logging.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
      • Level (string) -- [REQUIRED] The level of the logs.
      • Space (integer) -- The amount of file space, in KB, to use if the local file system is used for logging purposes.
      • Type (string) -- [REQUIRED] The type of log output which will be used.
• Name (string) -- The name of the logger definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• Loggers (list) --

  A list of loggers.

  • (dict) -- Information about a logger
    • Component (string) -- [REQUIRED] The component that will be subject to logging.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
    • Level (string) -- [REQUIRED] The level of the logs.
    • Space (integer) -- The amount of file space, in KB, to use if the local file system is used for logging purposes.
    • Type (string) -- [REQUIRED] The type of log output which will be used.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the resource definition.

  • Resources (list) -- A list of resources.
    • (dict) -- Information about a resource.
      • Id (string) -- [REQUIRED] The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
      • Name (string) -- [REQUIRED] The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
      • ResourceDataContainer (dict) -- [REQUIRED] A container of data for all resource types.
        • LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
          • GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
            • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
            • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
          • SourcePath (string) -- The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.
        • LocalVolumeResourceData (dict) -- Attributes that define the local volume resource.
          • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
          • GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
            • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
            • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
          • SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
        • S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
          • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
          • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
            • GroupOwner (string) -- [REQUIRED] The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
            • GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
          • S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
        • SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
          • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
          • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
            • GroupOwner (string) -- [REQUIRED] The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
            • GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
          • SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
        • SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
          • ARN (string) -- The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default.
          • AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
            • (string) --
• Name (string) -- The name of the resource definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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',
                    ]
                }
            }
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.
• Resources (list) --

  A list of resources.

  • (dict) -- Information about a resource.
    • Id (string) -- [REQUIRED] The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
    • Name (string) -- [REQUIRED] The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
    • ResourceDataContainer (dict) -- [REQUIRED] A container of data for all resource types.
      • LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
        • GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
          • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
          • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
        • SourcePath (string) -- The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.
      • LocalVolumeResourceData (dict) -- Attributes that define the local volume resource.
        • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
        • GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
          • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
          • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
        • SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
      • S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
        • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
        • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
          • GroupOwner (string) -- [REQUIRED] The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
          • GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
        • S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
      • SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
        • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
        • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
          • GroupOwner (string) -- [REQUIRED] The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
          • GroupPermission (string) -- [REQUIRED] The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
        • SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
      • SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
        • ARN (string) -- The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default.
        • AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
          • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• S3UrlSignerRole (string) -- [REQUIRED] The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
• SoftwareToUpdate (string) -- [REQUIRED] The piece of software on the Greengrass core that will be updated.
• UpdateAgentLogLevel (string) -- The minimum level of log statements that should be logged by the OTA Agent during an update.
• UpdateTargets (list) --

  [REQUIRED] The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.

  • (string) --
• UpdateTargetsArchitecture (string) -- [REQUIRED] The architecture of the cores which are the targets of an update.
• UpdateTargetsOperatingSystem (string) -- [REQUIRED] The operating system of the cores which are the targets of an update.

Return type

dict

Returns

Response Syntax

{
    'IotJobArn': 'string',
    'IotJobId': 'string',
    'PlatformSoftwareVersion': 'string'
}

Response Structure

• (dict) -- success
  • IotJobArn (string) -- The IoT Job ARN corresponding to this update.
  • IotJobId (string) -- The IoT Job Id corresponding to this update.
  • PlatformSoftwareVersion (string) -- The software version installed on the device or devices after the update.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• InitialVersion (dict) --

  Information about the initial version of the subscription definition.

  • Subscriptions (list) -- A list of subscriptions.
    • (dict) -- Information about a subscription.
      • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
      • Source (string) -- [REQUIRED] The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
      • Subject (string) -- [REQUIRED] The MQTT topic used to route the message.
      • Target (string) -- [REQUIRED] Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
• Name (string) -- The name of the subscription definition.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.

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'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.
• Subscriptions (list) --

  A list of subscriptions.

  • (dict) -- Information about a subscription.
    • Id (string) -- [REQUIRED] A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
    • Source (string) -- [REQUIRED] The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
    • Subject (string) -- [REQUIRED] The MQTT topic used to route the message.
    • Target (string) -- [REQUIRED] Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
  • Id (string) -- The ID of the parent definition that the version is associated with.
  • Version (string) -- The ID of the version.

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'
)

Parameters

ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

Exceptions

• Greengrass.Client.exceptions.BadRequestException

delete_group(**kwargs)

Deletes a group.

See also: AWS API Documentation

Request Syntax

response = client.delete_group(
    GroupId='string'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'DisassociatedAt': 'string'
}

Response Structure

• (dict) -- success
  • DisassociatedAt (string) -- The time, in milliseconds since the epoch, when the role was disassociated from the group.

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()

Return type

dict

Returns

Response Syntax

{
    'DisassociatedAt': 'string'
}

Response Structure

• (dict) -- success
  • DisassociatedAt (string) -- The time when the service role was disassociated from the account.

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'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'AssociatedAt': 'string',
    'RoleArn': 'string'
}

Response Structure

• (dict) -- success
  • AssociatedAt (string) -- The time when the role was associated with the group.
  • RoleArn (string) -- The ARN of the role that is associated with the group.

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'
)

Parameters

BulkDeploymentId (string) -- [REQUIRED] The ID of the bulk deployment.

Return type

dict

Returns

Response Syntax

{
    'BulkDeploymentMetrics': {
        'InvalidInputRecords': 123,
        'RecordsProcessed': 123,
        'RetryAttempts': 123
    },
    'BulkDeploymentStatus': 'Initializing'|'Running'|'Completed'|'Stopping'|'Stopped'|'Failed',
    'CreatedAt': 'string',
    'ErrorDetails': [
        {
            'DetailedErrorCode': 'string',
            'DetailedErrorMessage': 'string'
        },
    ],
    'ErrorMessage': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- Success. The response body contains the status of the bulk deployment.
  • BulkDeploymentMetrics (dict) -- Relevant metrics on input records processed during bulk deployment.
    • InvalidInputRecords (integer) -- The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version.
    • RecordsProcessed (integer) -- The total number of group records from the input file that have been processed so far, or attempted.
    • RetryAttempts (integer) -- The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times.
  • BulkDeploymentStatus (string) -- The status of the bulk deployment.
  • CreatedAt (string) -- The time, in ISO format, when the deployment was created.
  • ErrorDetails (list) -- Error details
    • (dict) -- Details about the error.
      • DetailedErrorCode (string) -- A detailed error code.
      • DetailedErrorMessage (string) -- A detailed error message.
  • ErrorMessage (string) -- Error message
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

ThingName (string) -- [REQUIRED] The thing name.

Return type

dict

Returns

Response Syntax

{
    'ConnectivityInfo': [
        {
            'HostAddress': 'string',
            'Id': 'string',
            'Metadata': 'string',
            'PortNumber': 123
        },
    ],
    'Message': 'string'
}

Response Structure

• (dict) -- success
  • ConnectivityInfo (list) -- Connectivity info list.
    • (dict) -- Information about a Greengrass core's connectivity.
      • HostAddress (string) -- The endpoint for the Greengrass core. Can be an IP address or DNS.
      • Id (string) -- The ID of the connectivity information.
      • Metadata (string) -- Metadata for this endpoint.
      • PortNumber (integer) -- The port of the Greengrass core. Usually 8883.
  • Message (string) -- A message about the connectivity info request.

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'
)

Parameters

ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.
• ConnectorDefinitionVersionId (string) -- [REQUIRED] The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Connectors': [
            {
                'ConnectorArn': 'string',
                'Id': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the connector definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the connector definition version was created.
  • Definition (dict) -- Information about the connector definition version.
    • Connectors (list) -- A list of references to connectors in this version, with their corresponding configuration settings.
      • (dict) -- Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
        • ConnectorArn (string) -- The ARN of the connector.
        • Id (string) -- A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.
        • Parameters (dict) -- The parameters or configuration that the connector uses.
          • (string) --
            • (string) --
  • Id (string) -- The ID of the connector definition version.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Version (string) -- The version of the connector definition version.

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'
)

Parameters

CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.
• CoreDefinitionVersionId (string) -- [REQUIRED] The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

Return type

dict

Returns

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

• (dict) -- success
  • Arn (string) -- The ARN of the core definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the core definition version was created.
  • Definition (dict) -- Information about the core definition version.
    • Cores (list) -- A list of cores in the core definition version.
      • (dict) -- Information about a core.
        • CertificateArn (string) -- The ARN of the certificate associated with the core.
        • Id (string) -- A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
        • SyncShadow (boolean) -- If true, the core's local shadow is automatically synced with the cloud.
        • ThingArn (string) -- The ARN of the thing which is the core.
  • Id (string) -- The ID of the core definition version.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Version (string) -- The version of the core definition version.

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'
)

Parameters

• DeploymentId (string) -- [REQUIRED] The ID of the deployment.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'DeploymentStatus': 'string',
    'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
    'ErrorDetails': [
        {
            'DetailedErrorCode': 'string',
            'DetailedErrorMessage': 'string'
        },
    ],
    'ErrorMessage': 'string',
    'UpdatedAt': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the status of the deployment for the group.
  • DeploymentStatus (string) -- The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
  • DeploymentType (string) -- The type of the deployment.
  • ErrorDetails (list) -- Error details
    • (dict) -- Details about the error.
      • DetailedErrorCode (string) -- A detailed error code.
      • DetailedErrorMessage (string) -- A detailed error message.
  • ErrorMessage (string) -- Error message
  • UpdatedAt (string) -- The time, in milliseconds since the epoch, when the deployment status was updated.

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'
)

Parameters

DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• DeviceDefinitionVersionId (string) -- [REQUIRED] The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

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

• (dict) --
  • Arn (string) -- The ARN of the device definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the device definition version was created.
  • Definition (dict) -- Information about the device definition version.
    • Devices (list) -- A list of devices in the definition version.
      • (dict) -- Information about a device.
        • CertificateArn (string) -- The ARN of the certificate associated with the device.
        • Id (string) -- A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
        • SyncShadow (boolean) -- If true, the device's local shadow will be automatically synced with the cloud.
        • ThingArn (string) -- The thing ARN of the device.
  • Id (string) -- The ID of the device definition version.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Version (string) -- The version of the device definition version.

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'
)

Parameters

FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- success
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.
• FunctionDefinitionVersionId (string) -- [REQUIRED] The ID of the function definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListFunctionDefinitionVersions'' requests. If the version is the last one that was associated with a function definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

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

• (dict) -- success
  • Arn (string) -- The ARN of the function definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the function definition version was created.
  • Definition (dict) -- Information on the definition.
    • DefaultConfig (dict) -- The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
      • Execution (dict) -- Configuration information that specifies how a Lambda function runs.
        • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
        • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
          • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
          • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
    • Functions (list) -- A list of Lambda functions in this function definition version.
      • (dict) -- Information about a Lambda function.
        • FunctionArn (string) -- The ARN of the Lambda function.
        • FunctionConfiguration (dict) -- The configuration of the Lambda function.
          • EncodingType (string) -- The expected encoding type of the input payload for the function. The default is ''json''.
          • Environment (dict) -- The environment configuration of the function.
            • AccessSysfs (boolean) -- If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
            • Execution (dict) -- Configuration related to executing the Lambda function
              • IsolationMode (string) -- Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
              • RunAs (dict) -- Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
                • Gid (integer) -- The group ID whose permissions are used to run a Lambda function.
                • Uid (integer) -- The user ID whose permissions are used to run a Lambda function.
            • ResourceAccessPolicies (list) -- A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.
              • (dict) -- A policy used by the function to access a resource.
                • Permission (string) -- The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).
                • ResourceId (string) -- The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
            • Variables (dict) -- Environment variables for the Lambda function's configuration.
              • (string) --
                • (string) --
          • ExecArgs (string) -- The execution arguments.
          • Executable (string) -- The name of the function executable.
          • MemorySize (integer) -- The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.
          • Pinned (boolean) -- True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
          • Timeout (integer) -- The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
          • FunctionRuntimeOverride (string) -- The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
        • Id (string) -- A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
  • Id (string) -- The ID of the function definition version.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Version (string) -- The version of the function definition version.

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'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- success
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

Exceptions

• Greengrass.Client.exceptions.BadRequestException

get_group_certificate_authority(**kwargs)

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'
)

Parameters

• CertificateAuthorityId (string) -- [REQUIRED] The ID of the certificate authority.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'GroupCertificateAuthorityArn': 'string',
    'GroupCertificateAuthorityId': 'string',
    'PemEncodedCertificate': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the PKI Configuration.
  • GroupCertificateAuthorityArn (string) -- The ARN of the certificate authority for the group.
  • GroupCertificateAuthorityId (string) -- The ID of the certificate authority for the group.
  • PemEncodedCertificate (string) -- The PEM encoded certificate for the group.

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'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'CertificateAuthorityExpiryInMilliseconds': 'string',
    'CertificateExpiryInMilliseconds': 'string',
    'GroupId': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the PKI Configuration.
  • CertificateAuthorityExpiryInMilliseconds (string) -- The amount of time remaining before the certificate authority expires, in milliseconds.
  • CertificateExpiryInMilliseconds (string) -- The amount of time remaining before the certificate expires, in milliseconds.
  • GroupId (string) -- The ID of the group certificate configuration.

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'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• GroupVersionId (string) -- [REQUIRED] The ID of the group version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListGroupVersions'' requests. If the version is the last one that was associated with a group, the value also maps to the ''LatestVersion'' property of the corresponding ''GroupInformation'' object.

Return type

dict

Returns

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

• (dict) -- success
  • Arn (string) -- The ARN of the group version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the group version was created.
  • Definition (dict) -- Information about the group version definition.
    • ConnectorDefinitionVersionArn (string) -- The ARN of the connector definition version for this group.
    • CoreDefinitionVersionArn (string) -- The ARN of the core definition version for this group.
    • DeviceDefinitionVersionArn (string) -- The ARN of the device definition version for this group.
    • FunctionDefinitionVersionArn (string) -- The ARN of the function definition version for this group.
    • LoggerDefinitionVersionArn (string) -- The ARN of the logger definition version for this group.
    • ResourceDefinitionVersionArn (string) -- The ARN of the resource definition version for this group.
    • SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.
  • Id (string) -- The ID of the group that the version is associated with.
  • Version (string) -- The ID of the group version.

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'
)

Parameters

LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• LoggerDefinitionVersionId (string) -- [REQUIRED] The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Loggers': [
            {
                'Component': 'GreengrassSystem'|'Lambda',
                'Id': 'string',
                'Level': 'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
                'Space': 123,
                'Type': 'FileSystem'|'AWSCloudWatch'
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) -- success
  • Arn (string) -- The ARN of the logger definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the logger definition version was created.
  • Definition (dict) -- Information about the logger definition version.
    • Loggers (list) -- A list of loggers.
      • (dict) -- Information about a logger
        • Component (string) -- The component that will be subject to logging.
        • Id (string) -- A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
        • Level (string) -- The level of the logs.
        • Space (integer) -- The amount of file space, in KB, to use if the local file system is used for logging purposes.
        • Type (string) -- The type of log output which will be used.
  • Id (string) -- The ID of the logger definition version.
  • Version (string) -- The version of the logger definition version.

Exceptions

• Greengrass.Client.exceptions.BadRequestException

get_paginator(operation_name)

Create a paginator for an operation.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").

Raises OperationNotPageableError

Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.

Return type

L{botocore.paginate.Paginator}

Returns

A paginator object.

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'
)

Parameters

ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- success
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.
• ResourceDefinitionVersionId (string) -- [REQUIRED] The ID of the resource definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListResourceDefinitionVersions'' requests. If the version is the last one that was associated with a resource definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Resources': [
            {
                'Id': 'string',
                'Name': 'string',
                'ResourceDataContainer': {
                    'LocalDeviceResourceData': {
                        'GroupOwnerSetting': {
                            'AutoAddGroupOwner': True|False,
                            'GroupOwner': 'string'
                        },
                        'SourcePath': 'string'
                    },
                    'LocalVolumeResourceData': {
                        'DestinationPath': 'string',
                        'GroupOwnerSetting': {
                            'AutoAddGroupOwner': True|False,
                            'GroupOwner': 'string'
                        },
                        'SourcePath': 'string'
                    },
                    'S3MachineLearningModelResourceData': {
                        'DestinationPath': 'string',
                        'OwnerSetting': {
                            'GroupOwner': 'string',
                            'GroupPermission': 'ro'|'rw'
                        },
                        'S3Uri': 'string'
                    },
                    'SageMakerMachineLearningModelResourceData': {
                        'DestinationPath': 'string',
                        'OwnerSetting': {
                            'GroupOwner': 'string',
                            'GroupPermission': 'ro'|'rw'
                        },
                        'SageMakerJobArn': 'string'
                    },
                    'SecretsManagerSecretResourceData': {
                        'ARN': 'string',
                        'AdditionalStagingLabelsToDownload': [
                            'string',
                        ]
                    }
                }
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

• (dict) -- success
  • Arn (string) -- Arn of the resource definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the resource definition version was created.
  • Definition (dict) -- Information about the definition.
    • Resources (list) -- A list of resources.
      • (dict) -- Information about a resource.
        • Id (string) -- The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
        • Name (string) -- The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
        • ResourceDataContainer (dict) -- A container of data for all resource types.
          • LocalDeviceResourceData (dict) -- Attributes that define the local device resource.
            • GroupOwnerSetting (dict) -- Group/owner related settings for local resources.
              • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
              • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
            • SourcePath (string) -- The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.
          • LocalVolumeResourceData (dict) -- Attributes that define the local volume resource.
            • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
            • GroupOwnerSetting (dict) -- Allows you to configure additional group privileges for the Lambda process. This field is optional.
              • AutoAddGroupOwner (boolean) -- If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
              • GroupOwner (string) -- The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
            • SourcePath (string) -- The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
          • S3MachineLearningModelResourceData (dict) -- Attributes that define an Amazon S3 machine learning resource.
            • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
            • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
              • GroupOwner (string) -- The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
              • GroupPermission (string) -- The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
            • S3Uri (string) -- The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
          • SageMakerMachineLearningModelResourceData (dict) -- Attributes that define an Amazon SageMaker machine learning resource.
            • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
            • OwnerSetting (dict) -- The owner setting for downloaded machine learning resources.
              • GroupOwner (string) -- The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
              • GroupPermission (string) -- The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
            • SageMakerJobArn (string) -- The ARN of the Amazon SageMaker training job that represents the source model.
          • SecretsManagerSecretResourceData (dict) -- Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
            • ARN (string) -- The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default.
            • AdditionalStagingLabelsToDownload (list) -- Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
              • (string) --
  • Id (string) -- The ID of the resource definition version.
  • Version (string) -- The version of the resource definition version.

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()

Return type

dict

Returns

Response Syntax

{
    'AssociatedAt': 'string',
    'RoleArn': 'string'
}

Response Structure

• (dict) -- success
  • AssociatedAt (string) -- The time when the service role was associated with the account.
  • RoleArn (string) -- The ARN of the role which is associated with the account.

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'
)

Parameters

SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the definition.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
  • Id (string) -- The ID of the definition.
  • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
  • LatestVersion (string) -- The ID of the latest version associated with the definition.
  • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
  • Name (string) -- The name of the definition.
  • tags (dict) -- Tag(s) attached to the resource arn.
    • (string) --
      • (string) --

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'
)

Parameters

• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
• SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.
• SubscriptionDefinitionVersionId (string) -- [REQUIRED] The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Subscriptions': [
            {
                'Id': 'string',
                'Source': 'string',
                'Subject': 'string',
                'Target': 'string'
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

• (dict) --
  • Arn (string) -- The ARN of the subscription definition version.
  • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the subscription definition version was created.
  • Definition (dict) -- Information about the subscription definition version.
    • Subscriptions (list) -- A list of subscriptions.
      • (dict) -- Information about a subscription.
        • Id (string) -- A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
        • Source (string) -- The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
        • Subject (string) -- The MQTT topic used to route the message.
        • Target (string) -- Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
  • Id (string) -- The ID of the subscription definition version.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Version (string) -- The version of the subscription definition version.

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'
)

Parameters

ThingName (string) -- [REQUIRED] The thing name.

Return type

dict

Returns

Response Syntax

{
    'RuntimeConfiguration': {
        'TelemetryConfiguration': {
            'ConfigurationSyncStatus': 'InSync'|'OutOfSync',
            'Telemetry': 'On'|'Off'
        }
    }
}

Response Structure

• (dict) -- Success. The response contains the runtime configuration for the given thing.
  • RuntimeConfiguration (dict) -- Runtime configuration for a thing.
    • TelemetryConfiguration (dict) -- Configuration for telemetry service.
      • ConfigurationSyncStatus (string) -- Synchronization status of the device reported configuration with the desired configuration.
      • Telemetry (string) -- Configure telemetry to be on or off.

Exceptions

• Greengrass.Client.exceptions.BadRequestException
• Greengrass.Client.exceptions.InternalServerErrorException

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

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'
)

Parameters

• BulkDeploymentId (string) -- [REQUIRED] The ID of the bulk deployment.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

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

• (dict) -- Success. The response body contains the list of deployments for the given group.
  • Deployments (list) -- A list of the individual group deployments in the bulk deployment operation.
    • (dict) -- Information about an individual group deployment in a bulk deployment operation.
      • CreatedAt (string) -- The time, in ISO format, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the group deployment.
      • DeploymentId (string) -- The ID of the group deployment.
      • DeploymentStatus (string) -- The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
      • DeploymentType (string) -- The type of the deployment.
      • ErrorDetails (list) -- Details about the error.
        • (dict) -- Details about the error.
          • DetailedErrorCode (string) -- A detailed error code.
          • DetailedErrorMessage (string) -- A detailed error message.
      • ErrorMessage (string) -- The error message for a failed deployment
      • GroupArn (string) -- The ARN of the Greengrass group.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'BulkDeployments': [
        {
            'BulkDeploymentArn': 'string',
            'BulkDeploymentId': 'string',
            'CreatedAt': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the list of bulk deployments.
  • BulkDeployments (list) -- A list of bulk deployments.
    • (dict) -- Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.
      • BulkDeploymentArn (string) -- The ARN of the bulk deployment.
      • BulkDeploymentId (string) -- The ID of the bulk deployment.
      • CreatedAt (string) -- The time, in ISO format, when the deployment was created.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Deployments': [
        {
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'GroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the list of deployments for the given group.
  • Deployments (list) -- A list of deployments for the requested groups.
    • (dict) -- Information about a deployment.
      • CreatedAt (string) -- The time, in milliseconds since the epoch, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the deployment.
      • DeploymentId (string) -- The ID of the deployment.
      • DeploymentType (string) -- The type of the deployment.
      • GroupArn (string) -- The ARN of the group for this deployment.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- success
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- Success. The response contains the IDs of all the Greengrass Lambda function definitions in this account.
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

list_group_certificate_authorities(**kwargs)

Retrieves the current CAs for a group.

See also: AWS API Documentation

Request Syntax

response = client.list_group_certificate_authorities(
    GroupId='string'
)

Parameters

GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'GroupCertificateAuthorities': [
        {
            'GroupCertificateAuthorityArn': 'string',
            'GroupCertificateAuthorityId': 'string'
        },
    ]
}

Response Structure

• (dict) -- Success. The response body contains the PKI Configuration.
  • GroupCertificateAuthorities (list) -- A list of certificate authorities associated with the group.
    • (dict) -- Information about a certificate authority for a group.
      • GroupCertificateAuthorityArn (string) -- The ARN of the certificate authority for the group.
      • GroupCertificateAuthorityId (string) -- The ID of the certificate authority for the group.

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'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- Success. The response contains the list of versions and metadata for the given group.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Groups (list) -- Information about a group.
    • (dict) -- Information about a group.
      • Arn (string) -- The ARN of the group.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the group was created.
      • Id (string) -- The ID of the group.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the group was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the group.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the group.
      • Name (string) -- The name of the group.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
• ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- success
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- The IDs of all the Greengrass resource definitions in this account.
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
• SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

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'
)

Parameters

• MaxResults (string) -- The maximum number of results to be returned per request.
• NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

list_tags_for_resource(**kwargs)

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'
)

Parameters

ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- HTTP Status Code 200: OK.
  • tags (dict) -- The key-value pair for the resource tag.
    • (string) --
      • (string) --

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'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• Force (boolean) -- If true, performs a best-effort only core reset.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'DeploymentArn': 'string',
    'DeploymentId': 'string'
}

Response Structure

• (dict) -- Success. The group's deployments were reset.
  • DeploymentArn (string) -- The ARN of the deployment.
  • DeploymentId (string) -- The ID of the deployment.

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'
    }
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• ExecutionRoleArn (string) -- [REQUIRED] The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.
• InputFileUri (string) -- [REQUIRED] The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.
• tags (dict) --

  Tag(s) to add to the new resource.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'BulkDeploymentArn': 'string',
    'BulkDeploymentId': 'string'
}

Response Structure

• (dict) -- success
  • BulkDeploymentArn (string) -- The ARN of the bulk deployment.
  • BulkDeploymentId (string) -- The ID of the bulk deployment.

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'
)

Parameters

BulkDeploymentId (string) -- [REQUIRED] The ID of the bulk deployment.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- Success. The bulk deployment is being stopped.

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'
    }
)

Parameters

• ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource.
• tags (dict) --

  The key-value pair for the resource tag.

  • (string) --
    • (string) --

Returns

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',
    ]
)

Parameters

• ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource.
• TagKeys (list) --

  [REQUIRED] An array of tag keys to delete

  • (string) --

Returns

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'
)

Parameters

• ConnectivityInfo (list) --

  A list of connectivity info.

  • (dict) -- Information about a Greengrass core's connectivity.
    • HostAddress (string) -- The endpoint for the Greengrass core. Can be an IP address or DNS.
    • Id (string) -- The ID of the connectivity information.
    • Metadata (string) -- Metadata for this endpoint.
    • PortNumber (integer) -- The port of the Greengrass core. Usually 8883.
• ThingName (string) -- [REQUIRED] The thing name.

Return type

dict

Returns

Response Syntax

{
    'Message': 'string',
    'Version': 'string'
}

Response Structure

• (dict) -- success
  • Message (string) -- A message about the connectivity info update request.
  • Version (string) -- The new version of the connectivity info.

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'
)

Parameters

• ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• CertificateExpiryInMilliseconds (string) -- The amount of time remaining before the certificate expires, in milliseconds.
• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.

Return type

dict

Returns

Response Syntax

{
    'CertificateAuthorityExpiryInMilliseconds': 'string',
    'CertificateExpiryInMilliseconds': 'string',
    'GroupId': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the PKI Configuration.
  • CertificateAuthorityExpiryInMilliseconds (string) -- The amount of time remaining before the certificate authority expires, in milliseconds.
  • CertificateExpiryInMilliseconds (string) -- The amount of time remaining before the certificate expires, in milliseconds.
  • GroupId (string) -- The ID of the group certificate configuration.

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'
)

Parameters

• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• Name (string) -- The name of the definition.
• ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• Name (string) -- The name of the definition.
• SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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'
)

Parameters

• TelemetryConfiguration (dict) --

  Configuration for telemetry service.

  • Telemetry (string) -- [REQUIRED] Configure telemetry to be on or off.
• ThingName (string) -- [REQUIRED] The thing name.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

Exceptions

• Greengrass.Client.exceptions.BadRequestException
• Greengrass.Client.exceptions.InternalServerErrorException

Paginators

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

class 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'
    }
)

Parameters

• BulkDeploymentId (string) -- [REQUIRED] The ID of the bulk deployment.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

• (dict) -- Success. The response body contains the list of deployments for the given group.
  • Deployments (list) -- A list of the individual group deployments in the bulk deployment operation.
    • (dict) -- Information about an individual group deployment in a bulk deployment operation.
      • CreatedAt (string) -- The time, in ISO format, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the group deployment.
      • DeploymentId (string) -- The ID of the group deployment.
      • DeploymentStatus (string) -- The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
      • DeploymentType (string) -- The type of the deployment.
      • ErrorDetails (list) -- Details about the error.
        • (dict) -- Details about the error.
          • DetailedErrorCode (string) -- A detailed error code.
          • DetailedErrorMessage (string) -- A detailed error message.
      • ErrorMessage (string) -- The error message for a failed deployment
      • GroupArn (string) -- The ARN of the Greengrass group.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'BulkDeployments': [
        {
            'BulkDeploymentArn': 'string',
            'BulkDeploymentId': 'string',
            'CreatedAt': 'string'
        },
    ],

}

Response Structure

• (dict) -- Success. The response body contains the list of bulk deployments.
  • BulkDeployments (list) -- A list of bulk deployments.
    • (dict) -- Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.
      • BulkDeploymentArn (string) -- The ARN of the bulk deployment.
      • BulkDeploymentId (string) -- The ID of the bulk deployment.
      • CreatedAt (string) -- The time, in ISO format, when the deployment was created.

class 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'
    }
)

Parameters

• ConnectorDefinitionId (string) -- [REQUIRED] The ID of the connector definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• CoreDefinitionId (string) -- [REQUIRED] The ID of the core definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Deployments': [
        {
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'GroupArn': 'string'
        },
    ],

}

Response Structure

• (dict) -- Success. The response body contains the list of deployments for the given group.
  • Deployments (list) -- A list of deployments for the requested groups.
    • (dict) -- Information about a deployment.
      • CreatedAt (string) -- The time, in milliseconds since the epoch, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the deployment.
      • DeploymentId (string) -- The ID of the deployment.
      • DeploymentType (string) -- The type of the deployment.
      • GroupArn (string) -- The ARN of the group for this deployment.

class 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'
    }
)

Parameters

• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• FunctionDefinitionId (string) -- [REQUIRED] The ID of the Lambda function definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- success
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) -- Success. The response contains the IDs of all the Greengrass Lambda function definitions in this account.
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- Success. The response contains the list of versions and metadata for the given group.
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

• (dict) --
  • Groups (list) -- Information about a group.
    • (dict) -- Information about a group.
      • Arn (string) -- The ARN of the group.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the group was created.
      • Id (string) -- The ID of the group.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the group was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the group.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the group.
      • Name (string) -- The name of the group.

class 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'
    }
)

Parameters

• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• ResourceDefinitionId (string) -- [REQUIRED] The ID of the resource definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) -- success
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) -- The IDs of all the Greengrass resource definitions in this account.
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --

class 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'
    }
)

Parameters

• SubscriptionDefinitionId (string) -- [REQUIRED] The ID of the subscription definition.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Versions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'Version': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • Versions (list) -- Information about a version.
    • (dict) -- Information about a version.
      • Arn (string) -- The ARN of the version.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the version was created.
      • Id (string) -- The ID of the parent definition that the version is associated with.
      • Version (string) -- The ID of the version.

class 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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Definitions': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --
  • Definitions (list) -- Information about a definition.
    • (dict) -- Information about a definition.
      • Arn (string) -- The ARN of the definition.
      • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
      • Id (string) -- The ID of the definition.
      • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
      • LatestVersion (string) -- The ID of the latest version associated with the definition.
      • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
      • Name (string) -- The name of the definition.
      • Tags (dict) -- Tag(s) attached to the resource arn.
        • (string) --
          • (string) --