Greengrass

Table of Contents

• Greengrass
  • Client

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()
• associate_service_role_to_account()
• can_paginate()
• 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_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()
• generate_presigned_url()
• get_associated_role()
• get_bulk_deployment_status()
• get_connectivity_info()
• 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_waiter()
• list_bulk_deployment_detailed_reports()
• list_bulk_deployments()
• 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()
• reset_deployments()
• start_bulk_deployment()
• stop_bulk_deployment()
• update_connectivity_info()
• update_core_definition()
• update_device_definition()
• update_function_definition()
• update_group()
• update_group_certificate_configuration()
• update_logger_definition()
• update_resource_definition()
• update_subscription_definition()

associate_role_to_group(**kwargs)

Associates a role with a group. Your AWS Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

See also: AWS API Documentation

Request Syntax

response = client.associate_role_to_group(
    GroupId='string',
    RoleArn='string'
)

Parameters

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

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.

associate_service_role_to_account(**kwargs)

Associates a role with your account. AWS Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

See also: AWS API Documentation

Request Syntax

response = client.associate_service_role_to_account(
    RoleArn='string'
)

Parameters

RoleArn (string) -- 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.

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 provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass groups must each contain exactly one AWS Greengrass core.

See also: AWS API Documentation

Request Syntax

response = client.create_core_definition(
    AmznClientToken='string',
    InitialVersion={
        'Cores': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    Name='string'
)

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) -- 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.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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 one AWS Greengrass core.

See also: AWS API Documentation

Request Syntax

response = client.create_core_definition_version(
    AmznClientToken='string',
    CoreDefinitionId='string',
    Cores=[
        {
            'CertificateArn': 'string',
            'Id': 'string',
            'SyncShadow': True|False,
            'ThingArn': 'string'
        },
    ]
)

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

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 version.
  • Version (string) -- The unique ID of the version.

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) -- The type of deployment. When used in ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.
• GroupId (string) -- [REQUIRED] The ID of the AWS 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.

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

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) -- 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.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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) -- 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) -- 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.

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 version.
  • Version (string) -- The unique ID of the 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': {
                    'EncodingType': 'binary'|'json',
                    'Environment': {
                        'AccessSysfs': True|False,
                        'ResourceAccessPolicies': [
                            {
                                'Permission': 'ro'|'rw',
                                'ResourceId': 'string'
                            },
                        ],
                        'Variables': {
                            'string': 'string'
                        }
                    },
                    'ExecArgs': 'string',
                    'Executable': 'string',
                    'MemorySize': 123,
                    'Pinned': True|False,
                    'Timeout': 123
                },
                'Id': 'string'
            },
        ]
    },
    Name='string'
)

Parameters

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

  Information about the initial version of the 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.
          • 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.
            • (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.
        • 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 lambdas for each request.
      • 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:_‑]+''.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The name of the definition.

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',
    FunctionDefinitionId='string',
    Functions=[
        {
            'FunctionArn': 'string',
            'FunctionConfiguration': {
                'EncodingType': 'binary'|'json',
                'Environment': {
                    'AccessSysfs': True|False,
                    'ResourceAccessPolicies': [
                        {
                            'Permission': 'ro'|'rw',
                            'ResourceId': 'string'
                        },
                    ],
                    'Variables': {
                        'string': 'string'
                    }
                },
                'ExecArgs': 'string',
                'Executable': 'string',
                'MemorySize': 123,
                'Pinned': True|False,
                'Timeout': 123
            },
            'Id': 'string'
        },
    ]
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• 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.
        • 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.
          • (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.
      • 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 lambdas for each request.
    • 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:_‑]+''.

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 version.
  • Version (string) -- The unique ID of the version.

create_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    AmznClientToken='string',
    InitialVersion={
        'CoreDefinitionVersionArn': 'string',
        'DeviceDefinitionVersionArn': 'string',
        'FunctionDefinitionVersionArn': 'string',
        'LoggerDefinitionVersionArn': 'string',
        'ResourceDefinitionVersionArn': 'string',
        'SubscriptionDefinitionVersionArn': 'string'
    },
    Name='string'
)

Parameters

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

  Information about the initial version of the 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 resource definition version ARN for this group.
  • SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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) -- A client token used to correlate requests and responses.
• GroupId (string) -- [REQUIRED] The ID of the AWS 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.

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',
    ResourceDefinitionVersionArn='string',
    SubscriptionDefinitionVersionArn='string'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• 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 AWS Greengrass group.
• LoggerDefinitionVersionArn (string) -- The ARN of the logger definition version for this group.
• ResourceDefinitionVersionArn (string) -- The resource definition version ARN 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 version.
  • Version (string) -- The unique ID of the version.

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

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) -- 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.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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) -- 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) -- 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.

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 version.
  • Version (string) -- The unique ID of the version.

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',
                        'S3Uri': 'string'
                    },
                    'SageMakerMachineLearningModelResourceData': {
                        'DestinationPath': 'string',
                        'SageMakerJobArn': 'string'
                    }
                }
            },
        ]
    },
    Name='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) -- 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 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, 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, 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 ''/proc'' or ''/sys''.
        • S3MachineLearningModelResourceData (dict) -- Attributes that define an S3 machine learning resource.
          • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
          • 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 SageMaker machine learning resource.
          • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
          • SageMakerJobArn (string) -- The ARN of the SageMaker training job that represents the source model.
• Name (string) -- The name of the resource 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The name of the definition.

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',
                    'S3Uri': 'string'
                },
                'SageMakerMachineLearningModelResourceData': {
                    'DestinationPath': 'string',
                    'SageMakerJobArn': '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) -- 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 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, 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, 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 ''/proc'' or ''/sys''.
      • S3MachineLearningModelResourceData (dict) -- Attributes that define an S3 machine learning resource.
        • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
        • 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 SageMaker machine learning resource.
        • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
        • SageMakerJobArn (string) -- The ARN of the SageMaker training job that represents the source model.

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 version.
  • Version (string) -- The unique ID of the version.

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='armv7l'|'x86_64'|'aarch64',
    UpdateTargetsOperatingSystem='ubuntu'|'raspbian'|'amazon_linux'
)

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• S3UrlSignerRole (string) -- The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
• SoftwareToUpdate (string) -- 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) --

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

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

Return type

dict

Returns

Response Syntax

{
    'IotJobArn': 'string',
    'IotJobId': '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.

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

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) -- 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, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.
      • Subject (string) -- The subject of the message.
      • Target (string) -- Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.
• Name (string) -- The 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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) -- 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) -- 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, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.
    • Subject (string) -- The subject of the message.
    • Target (string) -- Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (which represents the 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 version.
  • Version (string) -- The unique ID of the version.

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

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

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

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 AWS Greengrass group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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

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

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

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 AWS 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.

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.

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 ID of the AWS 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.

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

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

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.

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

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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] The ID of the core definition.
• CoreDefinitionVersionId (string) -- [REQUIRED] The ID of the core definition version.

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.

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 AWS 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: ''Pending'', ''InProgress'', ''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.

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

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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',
    NextToken='string'
)

Parameters

• DeviceDefinitionId (string) -- [REQUIRED] The ID of the device definition.
• DeviceDefinitionVersionId (string) -- [REQUIRED] 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.

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.

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

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The name of the definition.

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.
• 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': {
        'Functions': [
            {
                'FunctionArn': 'string',
                'FunctionConfiguration': {
                    'EncodingType': 'binary'|'json',
                    'Environment': {
                        'AccessSysfs': True|False,
                        'ResourceAccessPolicies': [
                            {
                                'Permission': 'ro'|'rw',
                                'ResourceId': 'string'
                            },
                        ],
                        'Variables': {
                            'string': 'string'
                        }
                    },
                    'ExecArgs': 'string',
                    'Executable': 'string',
                    'MemorySize': 123,
                    'Pinned': True|False,
                    'Timeout': 123
                },
                'Id': 'string'
            },
        ]
    },
    'Id': 'string',
    '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.
    • 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.
            • 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.
              • (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.
          • 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 lambdas for each request.
        • 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.

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 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) -- 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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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] The ID of the certificate authority.
• GroupId (string) -- [REQUIRED] The ID of the AWS 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.

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 AWS 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.

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 AWS Greengrass group.
• GroupVersionId (string) -- [REQUIRED] The ID of the group version.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (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.
    • 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 resource definition version ARN for this group.
    • SubscriptionDefinitionVersionArn (string) -- The ARN of the subscription definition version for this group.
  • Id (string) -- The ID of the group version.
  • Version (string) -- The unique ID for the 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] 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'
}

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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',
    NextToken='string'
)

Parameters

• LoggerDefinitionId (string) -- [REQUIRED] The ID of the logger definition.
• LoggerDefinitionVersionId (string) -- [REQUIRED] The ID of the logger definition version.
• 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.

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

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The name of the definition.

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.

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',
                        'S3Uri': 'string'
                    },
                    'SageMakerMachineLearningModelResourceData': {
                        'DestinationPath': 'string',
                        'SageMakerJobArn': '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 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, 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, 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 ''/proc'' or ''/sys''.
          • S3MachineLearningModelResourceData (dict) -- Attributes that define an S3 machine learning resource.
            • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
            • 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 SageMaker machine learning resource.
            • DestinationPath (string) -- The absolute local path of the resource inside the Lambda environment.
            • SageMakerJobArn (string) -- The ARN of the SageMaker training job that represents the source model.
  • Id (string) -- The ID of the resource definition version.
  • Version (string) -- The version of the resource definition version.

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.

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

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 latest version of the definition.
  • LatestVersionArn (string) -- The ARN of the latest version of the definition.
  • Name (string) -- The 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(
    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.

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, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.
        • Subject (string) -- The subject of the message.
        • Target (string) -- Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (which represents the 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.

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: ''Pending'', ''InProgress'', ''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.

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.
      • 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.

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 version.
      • Version (string) -- The unique ID of the 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) -- 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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The 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 ID of the AWS 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.

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 version.
      • Version (string) -- The unique ID of the 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) -- 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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The 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 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 version.
      • Version (string) -- The unique ID of the 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) -- 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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The 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 ID of the AWS 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.

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 AWS 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 version.
      • Version (string) -- The unique ID of the 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) -- 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 latest version of the group.
      • LatestVersionArn (string) -- The ARN of the latest version of 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 version.
      • Version (string) -- The unique ID of the 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) -- 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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The name of the definition.
  • 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 version.
      • Version (string) -- The unique ID of the version.

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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The 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) -- 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 version.
      • Version (string) -- The unique ID of the 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) -- 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'
        },
    ],
    '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 latest version of the definition.
      • LatestVersionArn (string) -- The ARN of the latest version of the definition.
      • Name (string) -- The name of the definition.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

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 AWS 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.

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

Parameters

• AmznClientToken (string) -- A client token used to correlate requests and responses.
• ExecutionRoleArn (string) -- 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) -- 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 100MB. Currently, Greengrass; supports only ''NewDeployment'' deployment types.

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.

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.

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.

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

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

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

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 AWS Greengrass group.
• Name (string) -- The name of the definition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) -- success

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 AWS 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.

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

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

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