AWSSDK.Greengrass

using AWSSDK.Greengrass.associate_role_to_group
associate_role_to_group([::AWSConfig], arguments::Dict)
associate_role_to_group([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}/role", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}/role", GroupId=, <keyword arguments>)

AssociateRoleToGroup Operation

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

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

RoleArn = ::String

Role arn you wish to associate with this group.

Returns

AssociateRoleToGroupResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.associate_service_role_to_account
associate_service_role_to_account([::AWSConfig], arguments::Dict)
associate_service_role_to_account([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/servicerole", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/servicerole", <keyword arguments>)

AssociateServiceRoleToAccount Operation

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

Arguments

RoleArn = ::String

Role arn you wish to associate with this account.

Returns

AssociateServiceRoleToAccountResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_core_definition
create_core_definition([::AWSConfig], arguments::Dict)
create_core_definition([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/cores", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/cores", <keyword arguments>)

CreateCoreDefinition Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = ["Cores" => [[ ... ], ...]]

Information on the initial version

 InitialVersion = ["Cores" =>  [[
            "CertificateArn" =>  ::String,
            "Id" =>  ::String,
            "SyncShadow" =>  ::Bool,
            "ThingArn" =>  ::String
        ], ...]]

Name = ::String

name of the core definition

Returns

CreateCoreDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_core_definition_version
create_core_definition_version([::AWSConfig], arguments::Dict)
create_core_definition_version([::AWSConfig]; CoreDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/cores/{CoreDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/cores/{CoreDefinitionId}/versions", CoreDefinitionId=, <keyword arguments>)

CreateCoreDefinitionVersion Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

CoreDefinitionId = ::String – Required

core definition Id

Cores = [[ ... ], ...]

Cores in the definition version.

 Cores = [[
        "CertificateArn" =>  ::String,
        "Id" =>  ::String,
        "SyncShadow" =>  ::Bool,
        "ThingArn" =>  ::String
    ], ...]

Returns

CreateCoreDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_deployment
create_deployment([::AWSConfig], arguments::Dict)
create_deployment([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/deployments", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/deployments", GroupId=, <keyword arguments>)

CreateDeployment Operation

Creates a deployment.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

DeploymentId = ::String

Id of the deployment if you wish to redeploy a previous deployment.

DeploymentType = "NewDeployment", "Redeployment", "ResetDeployment" or "ForceResetDeployment"

Type of deployment. When used in CreateDeployment, only NewDeployment and Redeployment are valid.

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

GroupVersionId = ::String

Group Version you wish to deploy.

Returns

CreateDeploymentResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_device_definition
create_device_definition([::AWSConfig], arguments::Dict)
create_device_definition([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/devices", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/devices", <keyword arguments>)

CreateDeviceDefinition Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = ["Devices" => [[ ... ], ...]]

Information on the initial version

 InitialVersion = ["Devices" =>  [[
            "CertificateArn" =>  ::String,
            "Id" =>  ::String,
            "SyncShadow" =>  ::Bool,
            "ThingArn" =>  ::String
        ], ...]]

Name = ::String

name of the device definition

Returns

CreateDeviceDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_device_definition_version
create_device_definition_version([::AWSConfig], arguments::Dict)
create_device_definition_version([::AWSConfig]; DeviceDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/devices/{DeviceDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/devices/{DeviceDefinitionId}/versions", DeviceDefinitionId=, <keyword arguments>)

CreateDeviceDefinitionVersion Operation

Creates a version of a device definition that has already been defined.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

DeviceDefinitionId = ::String – Required

device definition Id

Devices = [[ ... ], ...]

Devices in the definition version.

 Devices = [[
        "CertificateArn" =>  ::String,
        "Id" =>  ::String,
        "SyncShadow" =>  ::Bool,
        "ThingArn" =>  ::String
    ], ...]

Returns

CreateDeviceDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_function_definition
create_function_definition([::AWSConfig], arguments::Dict)
create_function_definition([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/functions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/functions", <keyword arguments>)

CreateFunctionDefinition Operation

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.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = ["Functions" => [[ ... ], ...]]

Information on the initial version

 InitialVersion = ["Functions" =>  [[
            "FunctionArn" =>  ::String,
            "FunctionConfiguration" =>  [
                "Environment" =>  ["Variables" =>  ::Dict{String,String}],
                "ExecArgs" =>  ::String,
                "Executable" =>  ::String,
                "MemorySize" =>  ::Int,
                "Pinned" =>  ::Bool,
                "Timeout" =>  ::Int
            ],
            "Id" =>  ::String
        ], ...]]

Name = ::String

name of the function definition

Returns

CreateFunctionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_function_definition_version
create_function_definition_version([::AWSConfig], arguments::Dict)
create_function_definition_version([::AWSConfig]; FunctionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/functions/{FunctionDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/functions/{FunctionDefinitionId}/versions", FunctionDefinitionId=, <keyword arguments>)

CreateFunctionDefinitionVersion Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

Functions = [[ ... ], ...]

Lambda functions in this function definition version.

 Functions = [[
        "FunctionArn" =>  ::String,
        "FunctionConfiguration" =>  [
            "Environment" =>  ["Variables" =>  ::Dict{String,String}],
            "ExecArgs" =>  ::String,
            "Executable" =>  ::String,
            "MemorySize" =>  ::Int,
            "Pinned" =>  ::Bool,
            "Timeout" =>  ::Int
        ],
        "Id" =>  ::String
    ], ...]

Returns

CreateFunctionDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_group
create_group([::AWSConfig], arguments::Dict)
create_group([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/groups", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/groups", <keyword arguments>)

CreateGroup Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = [ ... ]

Information on the initial version

 InitialVersion = [
        "CoreDefinitionVersionArn" =>  ::String,
        "DeviceDefinitionVersionArn" =>  ::String,
        "FunctionDefinitionVersionArn" =>  ::String,
        "LoggerDefinitionVersionArn" =>  ::String,
        "SubscriptionDefinitionVersionArn" =>  ::String
    ]

Name = ::String

name of the group

Returns

CreateGroupResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_group_certificate_authority
create_group_certificate_authority([::AWSConfig], arguments::Dict)
create_group_certificate_authority([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/certificateauthorities", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/certificateauthorities", GroupId=, <keyword arguments>)

CreateGroupCertificateAuthority Operation

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

CreateGroupCertificateAuthorityResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_group_version
create_group_version([::AWSConfig], arguments::Dict)
create_group_version([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/versions", GroupId=, <keyword arguments>)

CreateGroupVersion Operation

Creates a version of a group which has already been defined.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

CoreDefinitionVersionArn = ::String

Core definition version arn for this group.

DeviceDefinitionVersionArn = ::String

Device definition version arn for this group.

FunctionDefinitionVersionArn = ::String

Function definition version arn for this group.

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

LoggerDefinitionVersionArn = ::String

Logger definitionv ersion arn for this group.

SubscriptionDefinitionVersionArn = ::String

Subscription definition version arn for this group.

Returns

CreateGroupVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_logger_definition
create_logger_definition([::AWSConfig], arguments::Dict)
create_logger_definition([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/loggers", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/loggers", <keyword arguments>)

CreateLoggerDefinition Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = ["Loggers" => [[ ... ], ...]]

Information on the initial version

 InitialVersion = ["Loggers" =>  [[
            "Component" =>  "GreengrassSystem" or "Lambda",
            "Id" =>  ::String,
            "Level" =>  "DEBUG", "INFO", "WARN", "ERROR" or "FATAL",
            "Space" =>  ::Int,
            "Type" =>  "FileSystem" or "AWSCloudWatch"
        ], ...]]

Name = ::String

name of the logger definition

Returns

CreateLoggerDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_logger_definition_version
create_logger_definition_version([::AWSConfig], arguments::Dict)
create_logger_definition_version([::AWSConfig]; LoggerDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", LoggerDefinitionId=, <keyword arguments>)

CreateLoggerDefinitionVersion Operation

Creates a version of a logger definition that has already been defined.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

LoggerDefinitionId = ::String – Required

logger definition Id

Loggers = [[ ... ], ...]

List of loggers.

 Loggers = [[
        "Component" =>  "GreengrassSystem" or "Lambda",
        "Id" =>  ::String,
        "Level" =>  "DEBUG", "INFO", "WARN", "ERROR" or "FATAL",
        "Space" =>  ::Int,
        "Type" =>  "FileSystem" or "AWSCloudWatch"
    ], ...]

Returns

CreateLoggerDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_subscription_definition
create_subscription_definition([::AWSConfig], arguments::Dict)
create_subscription_definition([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/subscriptions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/subscriptions", <keyword arguments>)

CreateSubscriptionDefinition Operation

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

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

InitialVersion = ["Subscriptions" => [[ ... ], ...]]

Information on the initial version

 InitialVersion = ["Subscriptions" =>  [[
            "Id" =>  ::String,
            "Source" =>  ::String,
            "Subject" =>  ::String,
            "Target" =>  ::String
        ], ...]]

Name = ::String

name of the subscription definition

Returns

CreateSubscriptionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.create_subscription_definition_version
create_subscription_definition_version([::AWSConfig], arguments::Dict)
create_subscription_definition_version([::AWSConfig]; SubscriptionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", SubscriptionDefinitionId=, <keyword arguments>)

CreateSubscriptionDefinitionVersion Operation

Creates a version of a subscription definition which has already been defined.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

SubscriptionDefinitionId = ::String – Required

subscription definition Id

Subscriptions = [[ ... ], ...]

Subscriptions in the version.

 Subscriptions = [[
        "Id" =>  ::String,
        "Source" =>  ::String,
        "Subject" =>  ::String,
        "Target" =>  ::String
    ], ...]

Returns

CreateSubscriptionDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_core_definition
delete_core_definition([::AWSConfig], arguments::Dict)
delete_core_definition([::AWSConfig]; CoreDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/cores/{CoreDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/cores/{CoreDefinitionId}", CoreDefinitionId=)

DeleteCoreDefinition Operation

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

Arguments

CoreDefinitionId = ::String – Required

core definition Id

Returns

DeleteCoreDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_device_definition
delete_device_definition([::AWSConfig], arguments::Dict)
delete_device_definition([::AWSConfig]; DeviceDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/devices/{DeviceDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/devices/{DeviceDefinitionId}", DeviceDefinitionId=)

DeleteDeviceDefinition Operation

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

Arguments

DeviceDefinitionId = ::String – Required

device definition Id

Returns

DeleteDeviceDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_function_definition
delete_function_definition([::AWSConfig], arguments::Dict)
delete_function_definition([::AWSConfig]; FunctionDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/functions/{FunctionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/functions/{FunctionDefinitionId}", FunctionDefinitionId=)

DeleteFunctionDefinition Operation

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

Arguments

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

Returns

DeleteFunctionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_group
delete_group([::AWSConfig], arguments::Dict)
delete_group([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/groups/{GroupId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/groups/{GroupId}", GroupId=)

DeleteGroup Operation

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

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

DeleteGroupResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_logger_definition
delete_logger_definition([::AWSConfig], arguments::Dict)
delete_logger_definition([::AWSConfig]; LoggerDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/loggers/{LoggerDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/loggers/{LoggerDefinitionId}", LoggerDefinitionId=)

DeleteLoggerDefinition Operation

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

Arguments

LoggerDefinitionId = ::String – Required

logger definition Id

Returns

DeleteLoggerDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.delete_subscription_definition
delete_subscription_definition([::AWSConfig], arguments::Dict)
delete_subscription_definition([::AWSConfig]; SubscriptionDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", SubscriptionDefinitionId=)

DeleteSubscriptionDefinition Operation

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

Arguments

SubscriptionDefinitionId = ::String – Required

subscription definition Id

Returns

DeleteSubscriptionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.disassociate_role_from_group
disassociate_role_from_group([::AWSConfig], arguments::Dict)
disassociate_role_from_group([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/groups/{GroupId}/role", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/groups/{GroupId}/role", GroupId=)

DisassociateRoleFromGroup Operation

Disassociates the role from a group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

DisassociateRoleFromGroupResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.disassociate_service_role_from_account
disassociate_service_role_from_account([::AWSConfig], arguments::Dict)
disassociate_service_role_from_account([::AWSConfig]; )

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "DELETE", "/greengrass/servicerole", arguments::Dict)
greengrass([::AWSConfig], "DELETE", "/greengrass/servicerole", )

DisassociateServiceRoleFromAccount Operation

Disassociates the service role from the account. Without a service role, deployments will not work.

Arguments

Returns

DisassociateServiceRoleFromAccountResponse

Exceptions

InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_associated_role
get_associated_role([::AWSConfig], arguments::Dict)
get_associated_role([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/role", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/role", GroupId=)

GetAssociatedRole Operation

Retrieves the role associated with a particular group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

GetAssociatedRoleResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_connectivity_info
get_connectivity_info([::AWSConfig], arguments::Dict)
get_connectivity_info([::AWSConfig]; ThingName=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/things/{ThingName}/connectivityInfo", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/things/{ThingName}/connectivityInfo", ThingName=)

GetConnectivityInfo Operation

Retrieves the connectivity information for a core.

Arguments

ThingName = ::String – Required

Thing Name

Returns

GetConnectivityInfoResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_core_definition
get_core_definition([::AWSConfig], arguments::Dict)
get_core_definition([::AWSConfig]; CoreDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}", CoreDefinitionId=)

GetCoreDefinition Operation

Retrieves information about a core definition version.

Arguments

CoreDefinitionId = ::String – Required

core definition Id

Returns

GetCoreDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_core_definition_version
get_core_definition_version([::AWSConfig], arguments::Dict)
get_core_definition_version([::AWSConfig]; CoreDefinitionId=, CoreDefinitionVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}", CoreDefinitionId=, CoreDefinitionVersionId=)

GetCoreDefinitionVersion Operation

Retrieves information about a core definition version.

Arguments

CoreDefinitionId = ::String – Required

core definition Id

CoreDefinitionVersionId = ::String – Required

core definition version Id

Returns

GetCoreDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_deployment_status
get_deployment_status([::AWSConfig], arguments::Dict)
get_deployment_status([::AWSConfig]; DeploymentId=, GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status", DeploymentId=, GroupId=)

GetDeploymentStatus Operation

Returns the status of a deployment.

Arguments

DeploymentId = ::String – Required

the deployment Id

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

GetDeploymentStatusResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_device_definition
get_device_definition([::AWSConfig], arguments::Dict)
get_device_definition([::AWSConfig]; DeviceDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}", DeviceDefinitionId=)

GetDeviceDefinition Operation

Retrieves information about a device definition.

Arguments

DeviceDefinitionId = ::String – Required

device definition Id

Returns

GetDeviceDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_device_definition_version
get_device_definition_version([::AWSConfig], arguments::Dict)
get_device_definition_version([::AWSConfig]; DeviceDefinitionId=, DeviceDefinitionVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}", DeviceDefinitionId=, DeviceDefinitionVersionId=)

GetDeviceDefinitionVersion Operation

Retrieves information about a device definition version.

Arguments

DeviceDefinitionId = ::String – Required

device definition Id

DeviceDefinitionVersionId = ::String – Required

device definition version Id

Returns

GetDeviceDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_function_definition
get_function_definition([::AWSConfig], arguments::Dict)
get_function_definition([::AWSConfig]; FunctionDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}", FunctionDefinitionId=)

GetFunctionDefinition Operation

Retrieves information about a Lambda function definition, such as its creation time and latest version.

Arguments

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

Returns

GetFunctionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_function_definition_version
get_function_definition_version([::AWSConfig], arguments::Dict)
get_function_definition_version([::AWSConfig]; FunctionDefinitionId=, FunctionDefinitionVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}", FunctionDefinitionId=, FunctionDefinitionVersionId=)

GetFunctionDefinitionVersion Operation

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

Arguments

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

FunctionDefinitionVersionId = ::String – Required

Function definition version Id

Returns

GetFunctionDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_group
get_group([::AWSConfig], arguments::Dict)
get_group([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}", GroupId=)

GetGroup Operation

Retrieves information about a group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

GetGroupResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_group_certificate_authority
get_group_certificate_authority([::AWSConfig], arguments::Dict)
get_group_certificate_authority([::AWSConfig]; CertificateAuthorityId=, GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}", CertificateAuthorityId=, GroupId=)

GetGroupCertificateAuthority Operation

Retreives the CA associated with a group. Returns the public key of the CA.

Arguments

CertificateAuthorityId = ::String – Required

certificate authority Id

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

GetGroupCertificateAuthorityResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_group_certificate_configuration
get_group_certificate_configuration([::AWSConfig], arguments::Dict)
get_group_certificate_configuration([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", GroupId=)

GetGroupCertificateConfiguration Operation

Retrieves the current configuration for the CA used by the group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

GetGroupCertificateConfigurationResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_group_version
get_group_version([::AWSConfig], arguments::Dict)
get_group_version([::AWSConfig]; GroupId=, GroupVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/versions/{GroupVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/versions/{GroupVersionId}", GroupId=, GroupVersionId=)

GetGroupVersion Operation

Retrieves information about a group version.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

GroupVersionId = ::String – Required

Group version Id

Returns

GetGroupVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_logger_definition
get_logger_definition([::AWSConfig], arguments::Dict)
get_logger_definition([::AWSConfig]; LoggerDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}", LoggerDefinitionId=)

GetLoggerDefinition Operation

Retrieves information about a logger definition.

Arguments

LoggerDefinitionId = ::String – Required

logger definition Id

Returns

GetLoggerDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_logger_definition_version
get_logger_definition_version([::AWSConfig], arguments::Dict)
get_logger_definition_version([::AWSConfig]; LoggerDefinitionId=, LoggerDefinitionVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}", LoggerDefinitionId=, LoggerDefinitionVersionId=)

GetLoggerDefinitionVersion Operation

Retrieves information about a logger definition version.

Arguments

LoggerDefinitionId = ::String – Required

logger definition Id

LoggerDefinitionVersionId = ::String – Required

logger definition version Id

Returns

GetLoggerDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_service_role_for_account
get_service_role_for_account([::AWSConfig], arguments::Dict)
get_service_role_for_account([::AWSConfig]; )

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/servicerole", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/servicerole", )

GetServiceRoleForAccount Operation

Retrieves the service role that is attached to the account.

Arguments

Returns

GetServiceRoleForAccountResponse

Exceptions

InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_subscription_definition
get_subscription_definition([::AWSConfig], arguments::Dict)
get_subscription_definition([::AWSConfig]; SubscriptionDefinitionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", SubscriptionDefinitionId=)

GetSubscriptionDefinition Operation

Retrieves information about a subscription definition.

Arguments

SubscriptionDefinitionId = ::String – Required

subscription definition Id

Returns

GetSubscriptionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.get_subscription_definition_version
get_subscription_definition_version([::AWSConfig], arguments::Dict)
get_subscription_definition_version([::AWSConfig]; SubscriptionDefinitionId=, SubscriptionDefinitionVersionId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", SubscriptionDefinitionId=, SubscriptionDefinitionVersionId=)

GetSubscriptionDefinitionVersion Operation

Retrieves information about a subscription definition version.

Arguments

SubscriptionDefinitionId = ::String – Required

subscription definition Id

SubscriptionDefinitionVersionId = ::String – Required

subscription definition version Id

Returns

GetSubscriptionDefinitionVersionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_core_definition_versions
list_core_definition_versions([::AWSConfig], arguments::Dict)
list_core_definition_versions([::AWSConfig]; CoreDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores/{CoreDefinitionId}/versions", CoreDefinitionId=, <keyword arguments>)

ListCoreDefinitionVersions Operation

Lists versions of a core definition.

Arguments

CoreDefinitionId = ::String – Required

core definition Id

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListCoreDefinitionVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_core_definitions
list_core_definitions([::AWSConfig], arguments::Dict)
list_core_definitions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/cores", <keyword arguments>)

ListCoreDefinitions Operation

Retrieves a list of core definitions.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListCoreDefinitionsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_deployments
list_deployments([::AWSConfig], arguments::Dict)
list_deployments([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/deployments", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/deployments", GroupId=, <keyword arguments>)

ListDeployments Operation

Returns a history of deployments for the group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListDeploymentsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_device_definition_versions
list_device_definition_versions([::AWSConfig], arguments::Dict)
list_device_definition_versions([::AWSConfig]; DeviceDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices/{DeviceDefinitionId}/versions", DeviceDefinitionId=, <keyword arguments>)

ListDeviceDefinitionVersions Operation

Lists the versions of a device definition.

Arguments

DeviceDefinitionId = ::String – Required

device definition Id

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListDeviceDefinitionVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_device_definitions
list_device_definitions([::AWSConfig], arguments::Dict)
list_device_definitions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/devices", <keyword arguments>)

ListDeviceDefinitions Operation

Retrieves a list of device definitions.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListDeviceDefinitionsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_function_definition_versions
list_function_definition_versions([::AWSConfig], arguments::Dict)
list_function_definition_versions([::AWSConfig]; FunctionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions/{FunctionDefinitionId}/versions", FunctionDefinitionId=, <keyword arguments>)

ListFunctionDefinitionVersions Operation

Lists the versions of a Lambda function definition.

Arguments

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListFunctionDefinitionVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_function_definitions
list_function_definitions([::AWSConfig], arguments::Dict)
list_function_definitions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/functions", <keyword arguments>)

ListFunctionDefinitions Operation

Retrieves a list of Lambda function definitions.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListFunctionDefinitionsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_group_certificate_authorities
list_group_certificate_authorities([::AWSConfig], arguments::Dict)
list_group_certificate_authorities([::AWSConfig]; GroupId=)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/certificateauthorities", GroupId=)

ListGroupCertificateAuthorities Operation

Retrieves the current CAs for a group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

ListGroupCertificateAuthoritiesResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_group_versions
list_group_versions([::AWSConfig], arguments::Dict)
list_group_versions([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups/{GroupId}/versions", GroupId=, <keyword arguments>)

ListGroupVersions Operation

List the versions of a group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListGroupVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_groups
list_groups([::AWSConfig], arguments::Dict)
list_groups([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/groups", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/groups", <keyword arguments>)

ListGroups Operation

Retrieves a list of groups.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListGroupsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_logger_definition_versions
list_logger_definition_versions([::AWSConfig], arguments::Dict)
list_logger_definition_versions([::AWSConfig]; LoggerDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", LoggerDefinitionId=, <keyword arguments>)

ListLoggerDefinitionVersions Operation

Lists the versions of a logger definition.

Arguments

LoggerDefinitionId = ::String – Required

logger definition Id

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListLoggerDefinitionVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_logger_definitions
list_logger_definitions([::AWSConfig], arguments::Dict)
list_logger_definitions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/loggers", <keyword arguments>)

ListLoggerDefinitions Operation

Retrieves a list of logger definitions.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListLoggerDefinitionsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_subscription_definition_versions
list_subscription_definition_versions([::AWSConfig], arguments::Dict)
list_subscription_definition_versions([::AWSConfig]; SubscriptionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", SubscriptionDefinitionId=, <keyword arguments>)

ListSubscriptionDefinitionVersions Operation

Lists the versions of a subscription definition.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

SubscriptionDefinitionId = ::String – Required

subscription definition Id

Returns

ListSubscriptionDefinitionVersionsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.list_subscription_definitions
list_subscription_definitions([::AWSConfig], arguments::Dict)
list_subscription_definitions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions", arguments::Dict)
greengrass([::AWSConfig], "GET", "/greengrass/definition/subscriptions", <keyword arguments>)

ListSubscriptionDefinitions Operation

Retrieves a list of subscription definitions.

Arguments

MaxResults = ::String

Specifies the maximum number of list results to be returned in this page

NextToken = ::String

Specifies the pagination token used when iterating through a paginated request

Returns

ListSubscriptionDefinitionsResponse

Exceptions

.

See also: AWS API Documentation

using AWSSDK.Greengrass.reset_deployments
reset_deployments([::AWSConfig], arguments::Dict)
reset_deployments([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/deployments/$reset", arguments::Dict)
greengrass([::AWSConfig], "POST", "/greengrass/groups/{GroupId}/deployments/$reset", GroupId=, <keyword arguments>)

ResetDeployments Operation

Resets a group's deployments.

Arguments

X-Amzn-Client-Token = ::String

The client token used to request idempotent operations.

Force = ::Bool

When set to true, perform a best-effort only core reset.

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

ResetDeploymentsResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_connectivity_info
update_connectivity_info([::AWSConfig], arguments::Dict)
update_connectivity_info([::AWSConfig]; ThingName=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/things/{ThingName}/connectivityInfo", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/things/{ThingName}/connectivityInfo", ThingName=, <keyword arguments>)

UpdateConnectivityInfo Operation

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.

Arguments

ConnectivityInfo = [[ ... ], ...]

Connectivity info list

 ConnectivityInfo = [[
        "HostAddress" =>  ::String,
        "Id" =>  ::String,
        "Metadata" =>  ::String,
        "PortNumber" =>  ::Int
    ], ...]

ThingName = ::String – Required

Thing Name

Returns

UpdateConnectivityInfoResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_core_definition
update_core_definition([::AWSConfig], arguments::Dict)
update_core_definition([::AWSConfig]; CoreDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/definition/cores/{CoreDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/definition/cores/{CoreDefinitionId}", CoreDefinitionId=, <keyword arguments>)

UpdateCoreDefinition Operation

Updates a core definition.

Arguments

CoreDefinitionId = ::String – Required

core definition Id

Name = ::String

name of the definition

Returns

UpdateCoreDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_device_definition
update_device_definition([::AWSConfig], arguments::Dict)
update_device_definition([::AWSConfig]; DeviceDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/definition/devices/{DeviceDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/definition/devices/{DeviceDefinitionId}", DeviceDefinitionId=, <keyword arguments>)

UpdateDeviceDefinition Operation

Updates a device definition.

Arguments

DeviceDefinitionId = ::String – Required

device definition Id

Name = ::String

name of the definition

Returns

UpdateDeviceDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_function_definition
update_function_definition([::AWSConfig], arguments::Dict)
update_function_definition([::AWSConfig]; FunctionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/definition/functions/{FunctionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/definition/functions/{FunctionDefinitionId}", FunctionDefinitionId=, <keyword arguments>)

UpdateFunctionDefinition Operation

Updates a Lambda function definition.

Arguments

FunctionDefinitionId = ::String – Required

the unique Id of the lambda definition

Name = ::String

name of the definition

Returns

UpdateFunctionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_group
update_group([::AWSConfig], arguments::Dict)
update_group([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}", GroupId=, <keyword arguments>)

UpdateGroup Operation

Updates a group.

Arguments

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Name = ::String

name of the definition

Returns

UpdateGroupResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_group_certificate_configuration
update_group_certificate_configuration([::AWSConfig], arguments::Dict)
update_group_certificate_configuration([::AWSConfig]; GroupId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", GroupId=, <keyword arguments>)

UpdateGroupCertificateConfiguration Operation

Updates the Cert expiry time for a group.

Arguments

CertificateExpiryInMilliseconds = ::String

Amount of time when the certificate expires in milliseconds.

GroupId = ::String – Required

The unique Id of the AWS Greengrass Group

Returns

UpdateGroupCertificateConfigurationResponse

Exceptions

BadRequestException or InternalServerErrorException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_logger_definition
update_logger_definition([::AWSConfig], arguments::Dict)
update_logger_definition([::AWSConfig]; LoggerDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/definition/loggers/{LoggerDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/definition/loggers/{LoggerDefinitionId}", LoggerDefinitionId=, <keyword arguments>)

UpdateLoggerDefinition Operation

Updates a logger definition.

Arguments

LoggerDefinitionId = ::String – Required

logger definition Id

Name = ::String

name of the definition

Returns

UpdateLoggerDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation

using AWSSDK.Greengrass.update_subscription_definition
update_subscription_definition([::AWSConfig], arguments::Dict)
update_subscription_definition([::AWSConfig]; SubscriptionDefinitionId=, <keyword arguments>)

using AWSCore.Services.greengrass
greengrass([::AWSConfig], "PUT", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", arguments::Dict)
greengrass([::AWSConfig], "PUT", "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", SubscriptionDefinitionId=, <keyword arguments>)

UpdateSubscriptionDefinition Operation

Updates a subscription definition.

Arguments

Name = ::String

name of the definition

SubscriptionDefinitionId = ::String – Required

subscription definition Id

Returns

UpdateSubscriptionDefinitionResponse

Exceptions

BadRequestException.

See also: AWS API Documentation