Greengrass

Table of Contents

Client

class Greengrass.Client

A low-level client representing AWS Greengrass:

import boto3

client = boto3.client('greengrass')

These are the available methods:

associate_role_to_group(**kwargs)

Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.

See also: AWS API Documentation

Request Syntax

response = client.associate_role_to_group(
    GroupId='string',
    RoleArn='string'
)
Parameters
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
  • RoleArn (string) -- Role arn you wish to associate with this group.
Return type

dict

Returns

Response Syntax

{
    'AssociatedAt': 'string'
}

Response Structure

  • (dict) -- 200 response
    • AssociatedAt (string) -- Time the role arn was associated to your group.

associate_service_role_to_account(**kwargs)

Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy AWSGreengrassResourceAccessRolePolicy

See also: AWS API Documentation

Request Syntax

response = client.associate_service_role_to_account(
    RoleArn='string'
)
Parameters
RoleArn (string) -- Role arn you wish to associate with this account.
Return type
dict
Returns
Response Syntax
{
    'AssociatedAt': 'string'
}

Response Structure

  • (dict) -- 200 response
    • AssociatedAt (string) -- Time when the service role was associated to the account.
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.
create_core_definition(**kwargs)

Creates a core definition. You may optionally provide the initial version of the core definition or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

See also: AWS API Documentation

Request Syntax

response = client.create_core_definition(
    AmznClientToken='string',
    InitialVersion={
        'Cores': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    Name='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • Cores (list) -- Cores in the definition version.
      • (dict) -- Information on the core
        • CertificateArn (string) -- Certificate arn of the core.
        • Id (string) -- Element Id for this entry in the list.
        • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
        • ThingArn (string) -- Thing arn of the core.
  • Name (string) -- name of the core definition
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

create_core_definition_version(**kwargs)

Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

See also: AWS API Documentation

Request Syntax

response = client.create_core_definition_version(
    AmznClientToken='string',
    CoreDefinitionId='string',
    Cores=[
        {
            'CertificateArn': 'string',
            'Id': 'string',
            'SyncShadow': True|False,
            'ThingArn': 'string'
        },
    ]
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • CoreDefinitionId (string) -- [REQUIRED] core definition Id
  • Cores (list) --

    Cores in the definition version.

    • (dict) -- Information on the core
      • CertificateArn (string) -- Certificate arn of the core.
      • Id (string) -- Element Id for this entry in the list.
      • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
      • ThingArn (string) -- Thing arn of the core.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

create_deployment(**kwargs)

Creates a deployment.

See also: AWS API Documentation

Request Syntax

response = client.create_deployment(
    AmznClientToken='string',
    DeploymentId='string',
    DeploymentType='NewDeployment'|'Redeployment',
    GroupId='string',
    GroupVersionId='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • DeploymentId (string) -- Id of the deployment if you wish to redeploy a previous deployment.
  • DeploymentType (string) -- Type of deployment
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
  • GroupVersionId (string) -- Group Version you wish to deploy.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- Successfully deployed the given group
    • DeploymentArn (string) -- Arn of the deployment.
    • DeploymentId (string) -- Id of the deployment.

create_device_definition(**kwargs)

Creates a device definition. You may optinally provide the initial version of the device definition or use CreateDeviceDefinitionVersion at a later time.

See also: AWS API Documentation

Request Syntax

response = client.create_device_definition(
    AmznClientToken='string',
    InitialVersion={
        'Devices': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    Name='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • Devices (list) -- Devices in the definition version.
      • (dict) -- Information on a Device
        • CertificateArn (string) -- Certificate arn of the device.
        • Id (string) -- Element Id for this entry in the list.
        • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
        • ThingArn (string) -- Thing arn of the device.
  • Name (string) -- name of the device definition
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

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) -- The client token used to request idempotent operations.
  • DeviceDefinitionId (string) -- [REQUIRED] device definition Id
  • Devices (list) --

    Devices in the definition version.

    • (dict) -- Information on a Device
      • CertificateArn (string) -- Certificate arn of the device.
      • Id (string) -- Element Id for this entry in the list.
      • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
      • ThingArn (string) -- Thing arn of the device.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

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={
        'Functions': [
            {
                'FunctionArn': 'string',
                'FunctionConfiguration': {
                    'Environment': {
                        'Variables': {
                            'string': 'string'
                        }
                    },
                    'ExecArgs': 'string',
                    'Executable': 'string',
                    'MemorySize': 123,
                    'Pinned': True|False,
                    'Timeout': 123
                },
                'Id': 'string'
            },
        ]
    },
    Name='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • Functions (list) -- Lambda functions in this function definition version.
      • (dict) -- Information on function
        • FunctionArn (string) -- Arn of the Lambda function.
        • FunctionConfiguration (dict) -- Configuration of the function
          • Environment (dict) -- Environment of the function configuration
            • Variables (dict) -- Environment variables for the lambda function.
              • (string) --
                • (string) --
          • ExecArgs (string) -- Execution Arguments
          • Executable (string) -- Executable
          • MemorySize (integer) -- The memory size, in KB, you configured for the function.
          • Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
          • Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
        • Id (string) -- Id of the function in this version.
  • Name (string) -- name of the function definition
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

create_function_definition_version(**kwargs)

Create a version of a Lambda function definition that has already been defined.

See also: AWS API Documentation

Request Syntax

response = client.create_function_definition_version(
    AmznClientToken='string',
    FunctionDefinitionId='string',
    Functions=[
        {
            'FunctionArn': 'string',
            'FunctionConfiguration': {
                'Environment': {
                    'Variables': {
                        'string': 'string'
                    }
                },
                'ExecArgs': 'string',
                'Executable': 'string',
                'MemorySize': 123,
                'Pinned': True|False,
                'Timeout': 123
            },
            'Id': 'string'
        },
    ]
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • FunctionDefinitionId (string) -- [REQUIRED] the unique Id of the lambda definition
  • Functions (list) --

    Lambda functions in this function definition version.

    • (dict) -- Information on function
      • FunctionArn (string) -- Arn of the Lambda function.
      • FunctionConfiguration (dict) -- Configuration of the function
        • Environment (dict) -- Environment of the function configuration
          • Variables (dict) -- Environment variables for the lambda function.
            • (string) --
              • (string) --
        • ExecArgs (string) -- Execution Arguments
        • Executable (string) -- Executable
        • MemorySize (integer) -- The memory size, in KB, you configured for the function.
        • Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
        • Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
      • Id (string) -- Id of the function in this version.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

create_group(**kwargs)

Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    AmznClientToken='string',
    InitialVersion={
        'CoreDefinitionVersionArn': 'string',
        'DeviceDefinitionVersionArn': 'string',
        'FunctionDefinitionVersionArn': 'string',
        'LoggerDefinitionVersionArn': 'string',
        'SubscriptionDefinitionVersionArn': 'string'
    },
    Name='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • CoreDefinitionVersionArn (string) -- Core definition version arn for this group.
    • DeviceDefinitionVersionArn (string) -- Device definition version arn for this group.
    • FunctionDefinitionVersionArn (string) -- Function definition version arn for this group.
    • LoggerDefinitionVersionArn (string) -- Logger definitionv ersion arn for this group.
    • SubscriptionDefinitionVersionArn (string) -- Subscription definition version arn for this group.
  • Name (string) -- name of the group
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- Group created successfully
    • Arn (string) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

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) -- The client token used to request idempotent operations.
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
Return type

dict

Returns

Response Syntax

{
    'GroupCertificateAuthorityArn': 'string'
}

Response Structure

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

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',
    CoreDefinitionVersionArn='string',
    DeviceDefinitionVersionArn='string',
    FunctionDefinitionVersionArn='string',
    GroupId='string',
    LoggerDefinitionVersionArn='string',
    SubscriptionDefinitionVersionArn='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • CoreDefinitionVersionArn (string) -- Core definition version arn for this group.
  • DeviceDefinitionVersionArn (string) -- Device definition version arn for this group.
  • FunctionDefinitionVersionArn (string) -- Function definition version arn for this group.
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
  • LoggerDefinitionVersionArn (string) -- Logger definitionv ersion arn for this group.
  • SubscriptionDefinitionVersionArn (string) -- Subscription definition version arn for this group.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- the requested version of the Group
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

create_logger_definition(**kwargs)

Creates a logger definition. You may optionally provide the initial version of the logger definition or use CreateLoggerDefinitionVersion at a later time.

See also: AWS API Documentation

Request Syntax

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'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • Loggers (list) -- List of loggers.
      • (dict) -- Information on the Logger
        • Component (string) -- The component that will be subject to logs
        • Id (string) -- Element Id for this entry in the list.
        • Level (string) -- The level of the logs
        • Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
        • Type (string) -- The type which will be use for log output
  • Name (string) -- name of the logger definition
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

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) -- The client token used to request idempotent operations.
  • LoggerDefinitionId (string) -- [REQUIRED] logger definition Id
  • Loggers (list) --

    List of loggers.

    • (dict) -- Information on the Logger
      • Component (string) -- The component that will be subject to logs
      • Id (string) -- Element Id for this entry in the list.
      • Level (string) -- The level of the logs
      • Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
      • Type (string) -- The type which will be use for log output
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

create_subscription_definition(**kwargs)

Creates a subscription definition. You may optionally provide the initial version of the subscription definition or use CreateSubscriptionDefinitionVersion at a later time.

See also: AWS API Documentation

Request Syntax

response = client.create_subscription_definition(
    AmznClientToken='string',
    InitialVersion={
        'Subscriptions': [
            {
                'Id': 'string',
                'Source': 'string',
                'Subject': 'string',
                'Target': 'string'
            },
        ]
    },
    Name='string'
)
Parameters
  • AmznClientToken (string) -- The client token used to request idempotent operations.
  • InitialVersion (dict) --

    Information on the initial version

    • Subscriptions (list) -- Subscriptions in the version.
      • (dict) -- Information on subscription
        • Id (string) -- Element Id for this entry in the list.
        • Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
        • Subject (string) -- Subject of the message.
        • Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
  • Name (string) -- name of the subscription definition
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.

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) -- The client token used to request idempotent operations.
  • SubscriptionDefinitionId (string) -- [REQUIRED] subscription definition Id
  • Subscriptions (list) --

    Subscriptions in the version.

    • (dict) -- Information on subscription
      • Id (string) -- Element Id for this entry in the list.
      • Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
      • Subject (string) -- Subject of the message.
      • Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the version.
    • CreationTimestamp (string) -- Timestamp of when the version was created.
    • Id (string) -- Id of the resource container.
    • Version (string) -- Unique Id of a version.

delete_core_definition(**kwargs)

Deletes a core definition. The core definition must not have been used in a deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_core_definition(
    CoreDefinitionId='string'
)
Parameters
CoreDefinitionId (string) -- [REQUIRED] core definition Id
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
delete_device_definition(**kwargs)

Deletes a device definition. The device definition must not have been used in a deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_device_definition(
    DeviceDefinitionId='string'
)
Parameters
DeviceDefinitionId (string) -- [REQUIRED] device definition Id
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
delete_function_definition(**kwargs)

Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_function_definition(
    FunctionDefinitionId='string'
)
Parameters
FunctionDefinitionId (string) -- [REQUIRED] the unique Id of the lambda definition
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
delete_group(**kwargs)

Deletes a group. The group must not have been used in deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_group(
    GroupId='string'
)
Parameters
GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
delete_logger_definition(**kwargs)

Deletes a logger definition. The logger definition must not have been used in a deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_logger_definition(
    LoggerDefinitionId='string'
)
Parameters
LoggerDefinitionId (string) -- [REQUIRED] logger definition Id
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
delete_subscription_definition(**kwargs)

Deletes a subscription definition. The subscription definition must not have been used in a deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_subscription_definition(
    SubscriptionDefinitionId='string'
)
Parameters
SubscriptionDefinitionId (string) -- [REQUIRED] subscription definition Id
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) -- 200 response
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 unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{
    'DisassociatedAt': 'string'
}

Response Structure

  • (dict) -- 200 response
    • DisassociatedAt (string) -- Time when the role was disassociated from the group.
disassociate_service_role_from_account()

Disassociates the service role from the 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) -- 200 response
    • DisassociatedAt (string) -- Time when the service role was disassociated from the account.
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

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 unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{
    'AssociatedAt': 'string',
    'RoleArn': 'string'
}

Response Structure

  • (dict) -- 200 response
    • AssociatedAt (string) -- Time when the role was associated for the group.
    • RoleArn (string) -- Arn of the role that is associated with the group.
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] Thing Name
Return type
dict
Returns
Response Syntax
{
    'ConnectivityInfo': [
        {
            'HostAddress': 'string',
            'Id': 'string',
            'Metadata': 'string',
            'PortNumber': 123
        },
    ],
    'Message': 'string'
}

Response Structure

  • (dict) -- 200 response
    • ConnectivityInfo (list) -- Connectivity info array
      • (dict) -- Connectivity Info
        • HostAddress (string) -- Endpoint for the GGC. Can be an IP address or DNS.
        • Id (string) -- Element Id for this entry in the list.
        • Metadata (string) -- Metadata for this endpoint.
        • PortNumber (integer) -- Port of the GGC. Usually 8883.
    • Message (string) -- Response Text
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] core definition Id
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
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] core definition Id
  • CoreDefinitionVersionId (string) -- [REQUIRED] core definition version Id
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Cores': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) -- 200 response
    • Arn (string) -- Arn of the core definition version.
    • CreationTimestamp (string) -- Timestamp of when the core definition version was created.
    • Definition (dict) -- Information on definition
      • Cores (list) -- Cores in the definition version.
        • (dict) -- Information on the core
          • CertificateArn (string) -- Certificate arn of the core.
          • Id (string) -- Element Id for this entry in the list.
          • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
          • ThingArn (string) -- Thing arn of the core.
    • Id (string) -- Id of the core definition the version belongs to.
    • Version (string) -- Version of the core definition version.

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 deployment Id
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
Return type

dict

Returns

Response Syntax

{
    'DeploymentStatus': 'string',
    'ErrorMessage': 'string',
    'UpdatedAt': 'string'
}

Response Structure

  • (dict) -- The response body contains the status of a deployment for a group.
    • DeploymentStatus (string) -- Status of the deployment.
    • ErrorMessage (string) -- Error Message
    • UpdatedAt (string) -- Last time the deployment status was updated.

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] device definition Id
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
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'
)
Parameters
  • DeviceDefinitionId (string) -- [REQUIRED] device definition Id
  • DeviceDefinitionVersionId (string) -- [REQUIRED] device definition version Id
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Devices': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the device definition version.
    • CreationTimestamp (string) -- Timestamp of when the device definition version was created.
    • Definition (dict) -- Device definition version
      • Devices (list) -- Devices in the definition version.
        • (dict) -- Information on a Device
          • CertificateArn (string) -- Certificate arn of the device.
          • Id (string) -- Element Id for this entry in the list.
          • SyncShadow (boolean) -- If true, the local shadow value automatically syncs with the cloud's shadow state.
          • ThingArn (string) -- Thing arn of the device.
    • Id (string) -- Id of the device definition the version belongs to.
    • Version (string) -- Version of the device definition version.

get_function_definition(**kwargs)

Retrieves information about a Lambda function definition, such as 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 unique Id of the lambda definition
Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) -- 200 response
    • Arn (string) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
get_function_definition_version(**kwargs)

Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.

See also: AWS API Documentation

Request Syntax

response = client.get_function_definition_version(
    FunctionDefinitionId='string',
    FunctionDefinitionVersionId='string'
)
Parameters
  • FunctionDefinitionId (string) -- [REQUIRED] the unique Id of the lambda definition
  • FunctionDefinitionVersionId (string) -- [REQUIRED] Function definition version Id
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Functions': [
            {
                'FunctionArn': 'string',
                'FunctionConfiguration': {
                    'Environment': {
                        'Variables': {
                            'string': 'string'
                        }
                    },
                    'ExecArgs': 'string',
                    'Executable': 'string',
                    'MemorySize': 123,
                    'Pinned': True|False,
                    'Timeout': 123
                },
                'Id': 'string'
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) -- 200 response
    • Arn (string) -- Arn of the function definition version.
    • CreationTimestamp (string) -- Timestamp when the funtion definition version was created.
    • Definition (dict) -- Information on the function definition version
      • Functions (list) -- Lambda functions in this function definition version.
        • (dict) -- Information on function
          • FunctionArn (string) -- Arn of the Lambda function.
          • FunctionConfiguration (dict) -- Configuration of the function
            • Environment (dict) -- Environment of the function configuration
              • Variables (dict) -- Environment variables for the lambda function.
                • (string) --
                  • (string) --
            • ExecArgs (string) -- Execution Arguments
            • Executable (string) -- Executable
            • MemorySize (integer) -- The memory size, in KB, you configured for the function.
            • Pinned (boolean) -- Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
            • Timeout (integer) -- The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
          • Id (string) -- Id of the function in this version.
    • Id (string) -- Id of the function definition the version belongs to.
    • Version (string) -- Version of the function definition version.

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 unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) -- the requested Group
    • Arn (string) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
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] certificate authority Id
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
Return type

dict

Returns

Response Syntax

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

Response Structure

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

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 unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{
    'CertificateAuthorityExpiryInMilliseconds': 'string',
    'CertificateExpiryInMilliseconds': 'string',
    'GroupId': 'string'
}

Response Structure

  • (dict) -- The response body contains the PKI Configuration
    • CertificateAuthorityExpiryInMilliseconds (string) -- Amount of time when the certificate authority expires in milliseconds.
    • CertificateExpiryInMilliseconds (string) -- Amount of time when the certificate expires in milliseconds.
    • GroupId (string) -- Id of the group the certificate configuration belongs to.
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 unique Id of the AWS Greengrass Group
  • GroupVersionId (string) -- [REQUIRED] Group version Id
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'CoreDefinitionVersionArn': 'string',
        'DeviceDefinitionVersionArn': 'string',
        'FunctionDefinitionVersionArn': 'string',
        'LoggerDefinitionVersionArn': 'string',
        'SubscriptionDefinitionVersionArn': 'string'
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) -- 200 response
    • Arn (string) -- Arn of the group version.
    • CreationTimestamp (string) -- Timestamp when the group version was created.
    • Definition (dict) -- Information on the definition
      • CoreDefinitionVersionArn (string) -- Core definition version arn for this group.
      • DeviceDefinitionVersionArn (string) -- Device definition version arn for this group.
      • FunctionDefinitionVersionArn (string) -- Function definition version arn for this group.
      • LoggerDefinitionVersionArn (string) -- Logger definitionv ersion arn for this group.
      • SubscriptionDefinitionVersionArn (string) -- Subscription definition version arn for this group.
    • Id (string) -- Id of the group version.
    • Version (string) -- Unique Id for a version of the Group.

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] logger definition Id
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
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'
)
Parameters
  • LoggerDefinitionId (string) -- [REQUIRED] logger definition Id
  • LoggerDefinitionVersionId (string) -- [REQUIRED] logger definition version Id
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) -- test
    • Arn (string) -- Arn of the logger definition version.
    • CreationTimestamp (string) -- Timestamp of when the logger definition version was created.
    • Definition (dict) -- Information on definition
      • Loggers (list) -- List of loggers.
        • (dict) -- Information on the Logger
          • Component (string) -- The component that will be subject to logs
          • Id (string) -- Element Id for this entry in the list.
          • Level (string) -- The level of the logs
          • Space (integer) -- Amount of hardware space, in KB, to use if file system is used for logging purposes.
          • Type (string) -- The type which will be use for log output
    • Id (string) -- Id of the logger definition the version belongs to.
    • Version (string) -- Version of the logger definition version.

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

Retrieves the service role that is attached to the 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) -- 200 response
    • AssociatedAt (string) -- Time when the service role was associated to the account.
    • RoleArn (string) -- Role arn which is associated to the account.
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] subscription definition Id
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) -- Arn of the definition.
    • CreationTimestamp (string) -- Timestamp of when the definition was created.
    • Id (string) -- Id of the definition.
    • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
    • LatestVersion (string) -- Last version of the definition.
    • LatestVersionArn (string) -- Latest version arn of the definition.
    • Name (string) -- Name of the definition.
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(
    SubscriptionDefinitionId='string',
    SubscriptionDefinitionVersionId='string'
)
Parameters
  • SubscriptionDefinitionId (string) -- [REQUIRED] subscription definition Id
  • SubscriptionDefinitionVersionId (string) -- [REQUIRED] subscription definition version Id
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Arn (string) -- Arn of the subscription definition version.
    • CreationTimestamp (string) -- Timestamp of when the subscription definition version was created.
    • Definition (dict) -- Information on the definition
      • Subscriptions (list) -- Subscriptions in the version.
        • (dict) -- Information on subscription
          • Id (string) -- Element Id for this entry in the list.
          • Source (string) -- Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
          • Subject (string) -- Subject of the message.
          • Target (string) -- Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
    • Id (string) -- Id of the subscription definition the version belongs to.
    • Version (string) -- Version of the subscription definition version.

get_waiter(waiter_name)
list_core_definition_versions(**kwargs)

Lists 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] core definition Id
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
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) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Definitions (list) -- Definitions
      • (dict) -- Information on the Definition
        • Arn (string) -- Arn of the definition.
        • CreationTimestamp (string) -- Timestamp of when the definition was created.
        • Id (string) -- Id of the definition.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
        • LatestVersion (string) -- Last version of the definition.
        • LatestVersionArn (string) -- Latest version arn of the definition.
        • Name (string) -- Name of the definition.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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 unique Id of the AWS Greengrass Group
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

{
    'Deployments': [
        {
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'GroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- The response body contains the list of deployments for the given group Id
    • Deployments (list) -- Information on deployments
      • (dict) -- Information on the deployment
        • CreatedAt (string) -- Timestamp when the deployment was created.
        • DeploymentArn (string) -- Arn of the deployment.
        • DeploymentId (string) -- Id of the deployment.
        • GroupArn (string) -- Arn of the group for this deployment.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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] device definition Id
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
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) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Definitions (list) -- Definitions
      • (dict) -- Information on the Definition
        • Arn (string) -- Arn of the definition.
        • CreationTimestamp (string) -- Timestamp of when the definition was created.
        • Id (string) -- Id of the definition.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
        • LatestVersion (string) -- Last version of the definition.
        • LatestVersionArn (string) -- Latest version arn of the definition.
        • Name (string) -- Name of the definition.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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 unique Id of the lambda definition
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- 200 response
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
    • Versions (list) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- The Ids of all the Greengrass Function Definitions in this account.
    • Definitions (list) -- Definitions
      • (dict) -- Information on the Definition
        • Arn (string) -- Arn of the definition.
        • CreationTimestamp (string) -- Timestamp of when the definition was created.
        • Id (string) -- Id of the definition.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
        • LatestVersion (string) -- Last version of the definition.
        • LatestVersionArn (string) -- Latest version arn of the definition.
        • Name (string) -- Name of the definition.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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 unique Id of the AWS Greengrass Group
Return type
dict
Returns
Response Syntax
{
    'GroupCertificateAuthorities': [
        {
            'GroupCertificateAuthorityArn': 'string',
            'GroupCertificateAuthorityId': 'string'
        },
    ]
}

Response Structure

  • (dict) -- The response body contains the PKI Configuration
    • GroupCertificateAuthorities (list) -- List of certificate authorities associated with the group.
      • (dict) -- Information on group certificate authority properties
        • GroupCertificateAuthorityArn (string) -- Arn of the certificate authority for the group.
        • GroupCertificateAuthorityId (string) -- Id of the certificate authority for the group.
list_group_versions(**kwargs)

List 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 unique Id of the AWS Greengrass Group
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- the list of versions and metadata for the given group Id
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.
    • Versions (list) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
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) -- Groups
      • (dict) -- Information of a group
        • Arn (string) -- Arn of a group.
        • CreationTimestamp (string) -- Timestamp of when the group was created.
        • Id (string) -- Id of a group.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the group.
        • LatestVersion (string) -- Last version of the group.
        • LatestVersionArn (string) -- Latest version arn of the group.
        • Name (string) -- Name of a group.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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] logger definition Id
  • MaxResults (string) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
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) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Definitions (list) -- Definitions
      • (dict) -- Information on the Definition
        • Arn (string) -- Arn of the definition.
        • CreationTimestamp (string) -- Timestamp of when the definition was created.
        • Id (string) -- Id of the definition.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
        • LatestVersion (string) -- Last version of the definition.
        • LatestVersionArn (string) -- Latest version arn of the definition.
        • Name (string) -- Name of the definition.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
  • SubscriptionDefinitionId (string) -- [REQUIRED] subscription definition Id
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) -- Versions
      • (dict) -- Information on the version
        • Arn (string) -- Arn of the version.
        • CreationTimestamp (string) -- Timestamp of when the version was created.
        • Id (string) -- Id of the resource container.
        • Version (string) -- Unique Id of a version.

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) -- Specifies the maximum number of list results to be returned in this page
  • NextToken (string) -- Specifies the pagination token used when iterating through a paginated request
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • Definitions (list) -- Definitions
      • (dict) -- Information on the Definition
        • Arn (string) -- Arn of the definition.
        • CreationTimestamp (string) -- Timestamp of when the definition was created.
        • Id (string) -- Id of the definition.
        • LastUpdatedTimestamp (string) -- Last updated timestamp of the definition.
        • LatestVersion (string) -- Last version of the definition.
        • LatestVersionArn (string) -- Latest version arn of the definition.
        • Name (string) -- Name of the definition.
    • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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

    Connectivity info array

    • (dict) -- Connectivity Info
      • HostAddress (string) -- Endpoint for the GGC. Can be an IP address or DNS.
      • Id (string) -- Element Id for this entry in the list.
      • Metadata (string) -- Metadata for this endpoint.
      • PortNumber (integer) -- Port of the GGC. Usually 8883.
  • ThingName (string) -- [REQUIRED] Thing Name
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- 200 response
    • Message (string) -- Response Text
    • Version (string) -- New Version

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] core definition Id
  • Name (string) -- name of the definition
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response

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] device definition Id
  • Name (string) -- name of the definition
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response

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 unique Id of the lambda definition
  • Name (string) -- name of the definition
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response

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 unique Id of the AWS Greengrass Group
  • Name (string) -- name of the definition
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response

update_group_certificate_configuration(**kwargs)

Updates the Cert 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) -- Amount of time when the certificate expires in milliseconds.
  • GroupId (string) -- [REQUIRED] The unique Id of the AWS Greengrass Group
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) -- The response body contains the PKI Configuration
    • CertificateAuthorityExpiryInMilliseconds (string) -- Amount of time when the certificate authority expires in milliseconds.
    • CertificateExpiryInMilliseconds (string) -- Amount of time when the certificate expires in milliseconds.
    • GroupId (string) -- Id of the group the certificate configuration belongs to.

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] logger definition Id
  • Name (string) -- name of the definition
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response

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) -- name of the definition
  • SubscriptionDefinitionId (string) -- [REQUIRED] subscription definition Id
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) -- 200 response