You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Greengrass::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



142
143
144
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 142

def initialize(*args)
  super
end

Instance Method Details

#associate_role_to_group(params = {}) ⇒ Types::AssociateRoleToGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.associate_role_to_group({
  group_id: "__string", # required
  role_arn: "__string",
})

Response structure


resp.associated_at #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)
  • :role_arn (String)

    Role arn you wish to associate with this group.

Returns:

See Also:



177
178
179
180
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 177

def associate_role_to_group(params = {}, options = {})
  req = build_request(:associate_role_to_group, params)
  req.send_request(options)
end

#associate_service_role_to_account(params = {}) ⇒ Types::AssociateServiceRoleToAccountResponse

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

Examples:

Request syntax with placeholder values


resp = client.({
  role_arn: "__string",
})

Response structure


resp.associated_at #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :role_arn (String)

    Role arn you wish to associate with this account.

Returns:

See Also:



208
209
210
211
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 208

def (params = {}, options = {})
  req = build_request(:associate_service_role_to_account, params)
  req.send_request(options)
end

#create_core_definition(params = {}) ⇒ Types::CreateCoreDefinitionResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_core_definition({
  amzn_client_token: "__string",
  initial_version: {
    cores: [
      {
        certificate_arn: "__string",
        id: "__string",
        sync_shadow: false,
        thing_arn: "__string",
      },
    ],
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



266
267
268
269
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 266

def create_core_definition(params = {}, options = {})
  req = build_request(:create_core_definition, params)
  req.send_request(options)
end

#create_core_definition_version(params = {}) ⇒ Types::CreateCoreDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_core_definition_version({
  amzn_client_token: "__string",
  core_definition_id: "__string", # required
  cores: [
    {
      certificate_arn: "__string",
      id: "__string",
      sync_shadow: false,
      thing_arn: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :core_definition_id (required, String)
  • :cores (Array<Types::Core>)

Returns:

See Also:



313
314
315
316
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 313

def create_core_definition_version(params = {}, options = {})
  req = build_request(:create_core_definition_version, params)
  req.send_request(options)
end

#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse

Creates a deployment.

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  amzn_client_token: "__string",
  deployment_id: "__string",
  deployment_type: "NewDeployment", # accepts NewDeployment, Redeployment
  group_id: "__string", # required
  group_version_id: "__string",
})

Response structure


resp.deployment_arn #=> String
resp.deployment_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :deployment_id (String)

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

  • :deployment_type (String)

    Type of deployment

  • :group_id (required, String)
  • :group_version_id (String)

    Group Version you wish to deploy.

Returns:

See Also:



357
358
359
360
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 357

def create_deployment(params = {}, options = {})
  req = build_request(:create_deployment, params)
  req.send_request(options)
end

#create_device_definition(params = {}) ⇒ Types::CreateDeviceDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_device_definition({
  amzn_client_token: "__string",
  initial_version: {
    devices: [
      {
        certificate_arn: "__string",
        id: "__string",
        sync_shadow: false,
        thing_arn: "__string",
      },
    ],
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



414
415
416
417
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 414

def create_device_definition(params = {}, options = {})
  req = build_request(:create_device_definition, params)
  req.send_request(options)
end

#create_device_definition_version(params = {}) ⇒ Types::CreateDeviceDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_device_definition_version({
  amzn_client_token: "__string",
  device_definition_id: "__string", # required
  devices: [
    {
      certificate_arn: "__string",
      id: "__string",
      sync_shadow: false,
      thing_arn: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :device_definition_id (required, String)
  • :devices (Array<Types::Device>)

Returns:

See Also:



461
462
463
464
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 461

def create_device_definition_version(params = {}, options = {})
  req = build_request(:create_device_definition_version, params)
  req.send_request(options)
end

#create_function_definition(params = {}) ⇒ Types::CreateFunctionDefinitionResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_function_definition({
  amzn_client_token: "__string",
  initial_version: {
    functions: [
      {
        function_arn: "__string",
        function_configuration: {
          environment: {
            variables: {
              "__string" => "__string",
            },
          },
          exec_args: "__string",
          executable: "__string",
          memory_size: 1,
          pinned: false,
          timeout: 1,
        },
        id: "__string",
      },
    ],
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



530
531
532
533
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 530

def create_function_definition(params = {}, options = {})
  req = build_request(:create_function_definition, params)
  req.send_request(options)
end

#create_function_definition_version(params = {}) ⇒ Types::CreateFunctionDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_function_definition_version({
  amzn_client_token: "__string",
  function_definition_id: "__string", # required
  functions: [
    {
      function_arn: "__string",
      function_configuration: {
        environment: {
          variables: {
            "__string" => "__string",
          },
        },
        exec_args: "__string",
        executable: "__string",
        memory_size: 1,
        pinned: false,
        timeout: 1,
      },
      id: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :function_definition_id (required, String)
  • :functions (Array<Types::Function>)

Returns:

See Also:



587
588
589
590
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 587

def create_function_definition_version(params = {}, options = {})
  req = build_request(:create_function_definition_version, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ Types::CreateGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_group({
  amzn_client_token: "__string",
  initial_version: {
    core_definition_version_arn: "__string",
    device_definition_version_arn: "__string",
    function_definition_version_arn: "__string",
    logger_definition_version_arn: "__string",
    subscription_definition_version_arn: "__string",
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :initial_version (Types::GroupVersion)

    Information on group version

  • :name (String)

Returns:

See Also:



640
641
642
643
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 640

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_group_certificate_authority(params = {}) ⇒ Types::CreateGroupCertificateAuthorityResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_group_certificate_authority({
  amzn_client_token: "__string",
  group_id: "__string", # required
})

Response structure


resp.group_certificate_authority_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :group_id (required, String)

Returns:

See Also:



671
672
673
674
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 671

def create_group_certificate_authority(params = {}, options = {})
  req = build_request(:create_group_certificate_authority, params)
  req.send_request(options)
end

#create_group_version(params = {}) ⇒ Types::CreateGroupVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_group_version({
  amzn_client_token: "__string",
  core_definition_version_arn: "__string",
  device_definition_version_arn: "__string",
  function_definition_version_arn: "__string",
  group_id: "__string", # required
  logger_definition_version_arn: "__string",
  subscription_definition_version_arn: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :core_definition_version_arn (String)
  • :device_definition_version_arn (String)
  • :function_definition_version_arn (String)
  • :group_id (required, String)
  • :logger_definition_version_arn (String)
  • :subscription_definition_version_arn (String)

Returns:

See Also:



722
723
724
725
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 722

def create_group_version(params = {}, options = {})
  req = build_request(:create_group_version, params)
  req.send_request(options)
end

#create_logger_definition(params = {}) ⇒ Types::CreateLoggerDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_logger_definition({
  amzn_client_token: "__string",
  initial_version: {
    loggers: [
      {
        component: "GreengrassSystem", # accepts GreengrassSystem, Lambda
        id: "__string",
        level: "DEBUG", # accepts DEBUG, INFO, WARN, ERROR, FATAL
        space: 1,
        type: "FileSystem", # accepts FileSystem, AWSCloudWatch
      },
    ],
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



780
781
782
783
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 780

def create_logger_definition(params = {}, options = {})
  req = build_request(:create_logger_definition, params)
  req.send_request(options)
end

#create_logger_definition_version(params = {}) ⇒ Types::CreateLoggerDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_logger_definition_version({
  amzn_client_token: "__string",
  logger_definition_id: "__string", # required
  loggers: [
    {
      component: "GreengrassSystem", # accepts GreengrassSystem, Lambda
      id: "__string",
      level: "DEBUG", # accepts DEBUG, INFO, WARN, ERROR, FATAL
      space: 1,
      type: "FileSystem", # accepts FileSystem, AWSCloudWatch
    },
  ],
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :logger_definition_id (required, String)
  • :loggers (Array<Types::Logger>)

Returns:

See Also:



828
829
830
831
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 828

def create_logger_definition_version(params = {}, options = {})
  req = build_request(:create_logger_definition_version, params)
  req.send_request(options)
end

#create_subscription_definition(params = {}) ⇒ Types::CreateSubscriptionDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_subscription_definition({
  amzn_client_token: "__string",
  initial_version: {
    subscriptions: [
      {
        id: "__string",
        source: "__string",
        subject: "__string",
        target: "__string",
      },
    ],
  },
  name: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



885
886
887
888
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 885

def create_subscription_definition(params = {}, options = {})
  req = build_request(:create_subscription_definition, params)
  req.send_request(options)
end

#create_subscription_definition_version(params = {}) ⇒ Types::CreateSubscriptionDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_subscription_definition_version({
  amzn_client_token: "__string",
  subscription_definition_id: "__string", # required
  subscriptions: [
    {
      id: "__string",
      source: "__string",
      subject: "__string",
      target: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :subscription_definition_id (required, String)
  • :subscriptions (Array<Types::Subscription>)

Returns:

See Also:



932
933
934
935
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 932

def create_subscription_definition_version(params = {}, options = {})
  req = build_request(:create_subscription_definition_version, params)
  req.send_request(options)
end

#delete_core_definition(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_core_definition({
  core_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :core_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



954
955
956
957
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 954

def delete_core_definition(params = {}, options = {})
  req = build_request(:delete_core_definition, params)
  req.send_request(options)
end

#delete_device_definition(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_device_definition({
  device_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



976
977
978
979
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 976

def delete_device_definition(params = {}, options = {})
  req = build_request(:delete_device_definition, params)
  req.send_request(options)
end

#delete_function_definition(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_function_definition({
  function_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :function_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



998
999
1000
1001
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 998

def delete_function_definition(params = {}, options = {})
  req = build_request(:delete_function_definition, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1019
1020
1021
1022
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1019

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_logger_definition(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_logger_definition({
  logger_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1041
1042
1043
1044
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1041

def delete_logger_definition(params = {}, options = {})
  req = build_request(:delete_logger_definition, params)
  req.send_request(options)
end

#delete_subscription_definition(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_subscription_definition({
  subscription_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :subscription_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1063
1064
1065
1066
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1063

def delete_subscription_definition(params = {}, options = {})
  req = build_request(:delete_subscription_definition, params)
  req.send_request(options)
end

#disassociate_role_from_group(params = {}) ⇒ Types::DisassociateRoleFromGroupResponse

Disassociates the role from a group.

Examples:

Request syntax with placeholder values


resp = client.disassociate_role_from_group({
  group_id: "__string", # required
})

Response structure


resp.disassociated_at #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



1090
1091
1092
1093
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1090

def disassociate_role_from_group(params = {}, options = {})
  req = build_request(:disassociate_role_from_group, params)
  req.send_request(options)
end

#disassociate_service_role_from_account(params = {}) ⇒ Types::DisassociateServiceRoleFromAccountResponse

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

Examples:

Response structure


resp.disassociated_at #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



1110
1111
1112
1113
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1110

def (params = {}, options = {})
  req = build_request(:disassociate_service_role_from_account, params)
  req.send_request(options)
end

#get_associated_role(params = {}) ⇒ Types::GetAssociatedRoleResponse

Retrieves the role associated with a particular group.

Examples:

Request syntax with placeholder values


resp = client.get_associated_role({
  group_id: "__string", # required
})

Response structure


resp.associated_at #=> String
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



1139
1140
1141
1142
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1139

def get_associated_role(params = {}, options = {})
  req = build_request(:get_associated_role, params)
  req.send_request(options)
end

#get_connectivity_info(params = {}) ⇒ Types::GetConnectivityInfoResponse

Retrieves the connectivity information for a core.

Examples:

Request syntax with placeholder values


resp = client.get_connectivity_info({
  thing_name: "__string", # required
})

Response structure


resp.connectivity_info #=> Array
resp.connectivity_info[0].host_address #=> String
resp.connectivity_info[0].id #=> String
resp.connectivity_info[0]. #=> String
resp.connectivity_info[0].port_number #=> Integer
resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :thing_name (required, String)

Returns:

See Also:



1172
1173
1174
1175
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1172

def get_connectivity_info(params = {}, options = {})
  req = build_request(:get_connectivity_info, params)
  req.send_request(options)
end

#get_core_definition(params = {}) ⇒ Types::GetCoreDefinitionResponse

Retrieves information about a core definition version.

Examples:

Request syntax with placeholder values


resp = client.get_core_definition({
  core_definition_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :core_definition_id (required, String)

Returns:

See Also:



1211
1212
1213
1214
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1211

def get_core_definition(params = {}, options = {})
  req = build_request(:get_core_definition, params)
  req.send_request(options)
end

#get_core_definition_version(params = {}) ⇒ Types::GetCoreDefinitionVersionResponse

Retrieves information about a core definition version.

Examples:

Request syntax with placeholder values


resp = client.get_core_definition_version({
  core_definition_id: "__string", # required
  core_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.cores #=> Array
resp.definition.cores[0].certificate_arn #=> String
resp.definition.cores[0].id #=> String
resp.definition.cores[0].sync_shadow #=> Boolean
resp.definition.cores[0].thing_arn #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :core_definition_id (required, String)
  • :core_definition_version_id (required, String)

Returns:

See Also:



1253
1254
1255
1256
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1253

def get_core_definition_version(params = {}, options = {})
  req = build_request(:get_core_definition_version, params)
  req.send_request(options)
end

#get_deployment_status(params = {}) ⇒ Types::GetDeploymentStatusResponse

Returns the status of a deployment.

Examples:

Request syntax with placeholder values


resp = client.get_deployment_status({
  deployment_id: "__string", # required
  group_id: "__string", # required
})

Response structure


resp.deployment_status #=> String
resp.error_message #=> String
resp.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :deployment_id (required, String)
  • :group_id (required, String)

Returns:

See Also:



1287
1288
1289
1290
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1287

def get_deployment_status(params = {}, options = {})
  req = build_request(:get_deployment_status, params)
  req.send_request(options)
end

#get_device_definition(params = {}) ⇒ Types::GetDeviceDefinitionResponse

Retrieves information about a device definition.

Examples:

Request syntax with placeholder values


resp = client.get_device_definition({
  device_definition_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_definition_id (required, String)

Returns:

See Also:



1326
1327
1328
1329
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1326

def get_device_definition(params = {}, options = {})
  req = build_request(:get_device_definition, params)
  req.send_request(options)
end

#get_device_definition_version(params = {}) ⇒ Types::GetDeviceDefinitionVersionResponse

Retrieves information about a device definition version.

Examples:

Request syntax with placeholder values


resp = client.get_device_definition_version({
  device_definition_id: "__string", # required
  device_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.devices #=> Array
resp.definition.devices[0].certificate_arn #=> String
resp.definition.devices[0].id #=> String
resp.definition.devices[0].sync_shadow #=> Boolean
resp.definition.devices[0].thing_arn #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_definition_id (required, String)
  • :device_definition_version_id (required, String)

Returns:

See Also:



1368
1369
1370
1371
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1368

def get_device_definition_version(params = {}, options = {})
  req = build_request(:get_device_definition_version, params)
  req.send_request(options)
end

#get_function_definition(params = {}) ⇒ Types::GetFunctionDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_function_definition({
  function_definition_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :function_definition_id (required, String)

Returns:

See Also:



1408
1409
1410
1411
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1408

def get_function_definition(params = {}, options = {})
  req = build_request(:get_function_definition, params)
  req.send_request(options)
end

#get_function_definition_version(params = {}) ⇒ Types::GetFunctionDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_function_definition_version({
  function_definition_id: "__string", # required
  function_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.functions #=> Array
resp.definition.functions[0].function_arn #=> String
resp.definition.functions[0].function_configuration.environment.variables #=> Hash
resp.definition.functions[0].function_configuration.environment.variables["__string"] #=> String
resp.definition.functions[0].function_configuration.exec_args #=> String
resp.definition.functions[0].function_configuration.executable #=> String
resp.definition.functions[0].function_configuration.memory_size #=> Integer
resp.definition.functions[0].function_configuration.pinned #=> Boolean
resp.definition.functions[0].function_configuration.timeout #=> Integer
resp.definition.functions[0].id #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :function_definition_id (required, String)
  • :function_definition_version_id (required, String)

Returns:

See Also:



1457
1458
1459
1460
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1457

def get_function_definition_version(params = {}, options = {})
  req = build_request(:get_function_definition_version, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ Types::GetGroupResponse

Retrieves information about a group.

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



1496
1497
1498
1499
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1496

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#get_group_certificate_authority(params = {}) ⇒ Types::GetGroupCertificateAuthorityResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_group_certificate_authority({
  certificate_authority_id: "__string", # required
  group_id: "__string", # required
})

Response structure


resp.group_certificate_authority_arn #=> String
resp.group_certificate_authority_id #=> String
resp.pem_encoded_certificate #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_id (required, String)
  • :group_id (required, String)

Returns:

See Also:



1531
1532
1533
1534
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1531

def get_group_certificate_authority(params = {}, options = {})
  req = build_request(:get_group_certificate_authority, params)
  req.send_request(options)
end

#get_group_certificate_configuration(params = {}) ⇒ Types::GetGroupCertificateConfigurationResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_group_certificate_configuration({
  group_id: "__string", # required
})

Response structure


resp.certificate_authority_expiry_in_milliseconds #=> String
resp.certificate_expiry_in_milliseconds #=> String
resp.group_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



1562
1563
1564
1565
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1562

def get_group_certificate_configuration(params = {}, options = {})
  req = build_request(:get_group_certificate_configuration, params)
  req.send_request(options)
end

#get_group_version(params = {}) ⇒ Types::GetGroupVersionResponse

Retrieves information about a group version.

Examples:

Request syntax with placeholder values


resp = client.get_group_version({
  group_id: "__string", # required
  group_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.core_definition_version_arn #=> String
resp.definition.device_definition_version_arn #=> String
resp.definition.function_definition_version_arn #=> String
resp.definition.logger_definition_version_arn #=> String
resp.definition.subscription_definition_version_arn #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)
  • :group_version_id (required, String)

Returns:

See Also:



1604
1605
1606
1607
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1604

def get_group_version(params = {}, options = {})
  req = build_request(:get_group_version, params)
  req.send_request(options)
end

#get_logger_definition(params = {}) ⇒ Types::GetLoggerDefinitionResponse

Retrieves information about a logger definition.

Examples:

Request syntax with placeholder values


resp = client.get_logger_definition({
  logger_definition_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)

Returns:

See Also:



1643
1644
1645
1646
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1643

def get_logger_definition(params = {}, options = {})
  req = build_request(:get_logger_definition, params)
  req.send_request(options)
end

#get_logger_definition_version(params = {}) ⇒ Types::GetLoggerDefinitionVersionResponse

Retrieves information about a logger definition version.

Examples:

Request syntax with placeholder values


resp = client.get_logger_definition_version({
  logger_definition_id: "__string", # required
  logger_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.loggers #=> Array
resp.definition.loggers[0].component #=> String, one of "GreengrassSystem", "Lambda"
resp.definition.loggers[0].id #=> String
resp.definition.loggers[0].level #=> String, one of "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.definition.loggers[0].space #=> Integer
resp.definition.loggers[0].type #=> String, one of "FileSystem", "AWSCloudWatch"
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)
  • :logger_definition_version_id (required, String)

Returns:

See Also:



1686
1687
1688
1689
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1686

def get_logger_definition_version(params = {}, options = {})
  req = build_request(:get_logger_definition_version, params)
  req.send_request(options)
end

#get_service_role_for_account(params = {}) ⇒ Types::GetServiceRoleForAccountResponse

Retrieves the service role that is attached to the account.

Examples:

Response structure


resp.associated_at #=> String
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



1707
1708
1709
1710
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1707

def (params = {}, options = {})
  req = build_request(:get_service_role_for_account, params)
  req.send_request(options)
end

#get_subscription_definition(params = {}) ⇒ Types::GetSubscriptionDefinitionResponse

Retrieves information about a subscription definition.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_definition({
  subscription_definition_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.id #=> String
resp.last_updated_timestamp #=> String
resp.latest_version #=> String
resp.latest_version_arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :subscription_definition_id (required, String)

Returns:

See Also:



1746
1747
1748
1749
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1746

def get_subscription_definition(params = {}, options = {})
  req = build_request(:get_subscription_definition, params)
  req.send_request(options)
end

#get_subscription_definition_version(params = {}) ⇒ Types::GetSubscriptionDefinitionVersionResponse

Retrieves information about a subscription definition version.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_definition_version({
  subscription_definition_id: "__string", # required
  subscription_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.subscriptions #=> Array
resp.definition.subscriptions[0].id #=> String
resp.definition.subscriptions[0].source #=> String
resp.definition.subscriptions[0].subject #=> String
resp.definition.subscriptions[0].target #=> String
resp.id #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :subscription_definition_id (required, String)
  • :subscription_definition_version_id (required, String)

Returns:

See Also:



1788
1789
1790
1791
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1788

def get_subscription_definition_version(params = {}, options = {})
  req = build_request(:get_subscription_definition_version, params)
  req.send_request(options)
end

#list_core_definition_versions(params = {}) ⇒ Types::ListCoreDefinitionVersionsResponse

Lists versions of a core definition.

Examples:

Request syntax with placeholder values


resp = client.list_core_definition_versions({
  core_definition_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :core_definition_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



1827
1828
1829
1830
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1827

def list_core_definition_versions(params = {}, options = {})
  req = build_request(:list_core_definition_versions, params)
  req.send_request(options)
end

#list_core_definitions(params = {}) ⇒ Types::ListCoreDefinitionsResponse

Retrieves a list of core definitions.

Examples:

Request syntax with placeholder values


resp = client.list_core_definitions({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.definitions #=> Array
resp.definitions[0].arn #=> String
resp.definitions[0].creation_timestamp #=> String
resp.definitions[0].id #=> String
resp.definitions[0].last_updated_timestamp #=> String
resp.definitions[0].latest_version #=> String
resp.definitions[0].latest_version_arn #=> String
resp.definitions[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



1866
1867
1868
1869
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1866

def list_core_definitions(params = {}, options = {})
  req = build_request(:list_core_definitions, params)
  req.send_request(options)
end

#list_deployments(params = {}) ⇒ Types::ListDeploymentsResponse

Returns a history of deployments for the group.

Examples:

Request syntax with placeholder values


resp = client.list_deployments({
  group_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.deployments #=> Array
resp.deployments[0].created_at #=> String
resp.deployments[0].deployment_arn #=> String
resp.deployments[0].deployment_id #=> String
resp.deployments[0].group_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



1905
1906
1907
1908
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1905

def list_deployments(params = {}, options = {})
  req = build_request(:list_deployments, params)
  req.send_request(options)
end

#list_device_definition_versions(params = {}) ⇒ Types::ListDeviceDefinitionVersionsResponse

Lists the versions of a device definition.

Examples:

Request syntax with placeholder values


resp = client.list_device_definition_versions({
  device_definition_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_definition_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



1944
1945
1946
1947
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1944

def list_device_definition_versions(params = {}, options = {})
  req = build_request(:list_device_definition_versions, params)
  req.send_request(options)
end

#list_device_definitions(params = {}) ⇒ Types::ListDeviceDefinitionsResponse

Retrieves a list of device definitions.

Examples:

Request syntax with placeholder values


resp = client.list_device_definitions({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.definitions #=> Array
resp.definitions[0].arn #=> String
resp.definitions[0].creation_timestamp #=> String
resp.definitions[0].id #=> String
resp.definitions[0].last_updated_timestamp #=> String
resp.definitions[0].latest_version #=> String
resp.definitions[0].latest_version_arn #=> String
resp.definitions[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



1983
1984
1985
1986
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1983

def list_device_definitions(params = {}, options = {})
  req = build_request(:list_device_definitions, params)
  req.send_request(options)
end

#list_function_definition_versions(params = {}) ⇒ Types::ListFunctionDefinitionVersionsResponse

Lists the versions of a Lambda function definition.

Examples:

Request syntax with placeholder values


resp = client.list_function_definition_versions({
  function_definition_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :function_definition_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2022
2023
2024
2025
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2022

def list_function_definition_versions(params = {}, options = {})
  req = build_request(:list_function_definition_versions, params)
  req.send_request(options)
end

#list_function_definitions(params = {}) ⇒ Types::ListFunctionDefinitionsResponse

Retrieves a list of Lambda function definitions.

Examples:

Request syntax with placeholder values


resp = client.list_function_definitions({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.definitions #=> Array
resp.definitions[0].arn #=> String
resp.definitions[0].creation_timestamp #=> String
resp.definitions[0].id #=> String
resp.definitions[0].last_updated_timestamp #=> String
resp.definitions[0].latest_version #=> String
resp.definitions[0].latest_version_arn #=> String
resp.definitions[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2061
2062
2063
2064
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2061

def list_function_definitions(params = {}, options = {})
  req = build_request(:list_function_definitions, params)
  req.send_request(options)
end

#list_group_certificate_authorities(params = {}) ⇒ Types::ListGroupCertificateAuthoritiesResponse

Retrieves the current CAs for a group.

Examples:

Request syntax with placeholder values


resp = client.list_group_certificate_authorities({
  group_id: "__string", # required
})

Response structure


resp.group_certificate_authorities #=> Array
resp.group_certificate_authorities[0].group_certificate_authority_arn #=> String
resp.group_certificate_authorities[0].group_certificate_authority_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



2090
2091
2092
2093
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2090

def list_group_certificate_authorities(params = {}, options = {})
  req = build_request(:list_group_certificate_authorities, params)
  req.send_request(options)
end

#list_group_versions(params = {}) ⇒ Types::ListGroupVersionsResponse

List the versions of a group.

Examples:

Request syntax with placeholder values


resp = client.list_group_versions({
  group_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2129
2130
2131
2132
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2129

def list_group_versions(params = {}, options = {})
  req = build_request(:list_group_versions, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResponse

Retrieves a list of groups.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.groups #=> Array
resp.groups[0].arn #=> String
resp.groups[0].creation_timestamp #=> String
resp.groups[0].id #=> String
resp.groups[0].last_updated_timestamp #=> String
resp.groups[0].latest_version #=> String
resp.groups[0].latest_version_arn #=> String
resp.groups[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2168
2169
2170
2171
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2168

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_logger_definition_versions(params = {}) ⇒ Types::ListLoggerDefinitionVersionsResponse

Lists the versions of a logger definition.

Examples:

Request syntax with placeholder values


resp = client.list_logger_definition_versions({
  logger_definition_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)
  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2207
2208
2209
2210
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2207

def list_logger_definition_versions(params = {}, options = {})
  req = build_request(:list_logger_definition_versions, params)
  req.send_request(options)
end

#list_logger_definitions(params = {}) ⇒ Types::ListLoggerDefinitionsResponse

Retrieves a list of logger definitions.

Examples:

Request syntax with placeholder values


resp = client.list_logger_definitions({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.definitions #=> Array
resp.definitions[0].arn #=> String
resp.definitions[0].creation_timestamp #=> String
resp.definitions[0].id #=> String
resp.definitions[0].last_updated_timestamp #=> String
resp.definitions[0].latest_version #=> String
resp.definitions[0].latest_version_arn #=> String
resp.definitions[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2246
2247
2248
2249
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2246

def list_logger_definitions(params = {}, options = {})
  req = build_request(:list_logger_definitions, params)
  req.send_request(options)
end

#list_subscription_definition_versions(params = {}) ⇒ Types::ListSubscriptionDefinitionVersionsResponse

Lists the versions of a subscription definition.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_definition_versions({
  max_results: "__string",
  next_token: "__string",
  subscription_definition_id: "__string", # required
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].arn #=> String
resp.versions[0].creation_timestamp #=> String
resp.versions[0].id #=> String
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)
  • :subscription_definition_id (required, String)

Returns:

See Also:



2285
2286
2287
2288
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2285

def list_subscription_definition_versions(params = {}, options = {})
  req = build_request(:list_subscription_definition_versions, params)
  req.send_request(options)
end

#list_subscription_definitions(params = {}) ⇒ Types::ListSubscriptionDefinitionsResponse

Retrieves a list of subscription definitions.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_definitions({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.definitions #=> Array
resp.definitions[0].arn #=> String
resp.definitions[0].creation_timestamp #=> String
resp.definitions[0].id #=> String
resp.definitions[0].last_updated_timestamp #=> String
resp.definitions[0].latest_version #=> String
resp.definitions[0].latest_version_arn #=> String
resp.definitions[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:

See Also:



2324
2325
2326
2327
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2324

def list_subscription_definitions(params = {}, options = {})
  req = build_request(:list_subscription_definitions, params)
  req.send_request(options)
end

#update_connectivity_info(params = {}) ⇒ Types::UpdateConnectivityInfoResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_connectivity_info({
  connectivity_info: [
    {
      host_address: "__string",
      id: "__string",
      metadata: "__string",
      port_number: 1,
    },
  ],
  thing_name: "__string", # required
})

Response structure


resp.message #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



2366
2367
2368
2369
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2366

def update_connectivity_info(params = {}, options = {})
  req = build_request(:update_connectivity_info, params)
  req.send_request(options)
end

#update_core_definition(params = {}) ⇒ Struct

Updates a core definition.

Examples:

Request syntax with placeholder values


resp = client.update_core_definition({
  core_definition_id: "__string", # required
  name: "__string",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :core_definition_id (required, String)
  • :name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2390
2391
2392
2393
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2390

def update_core_definition(params = {}, options = {})
  req = build_request(:update_core_definition, params)
  req.send_request(options)
end

#update_device_definition(params = {}) ⇒ Struct

Updates a device definition.

Examples:

Request syntax with placeholder values


resp = client.update_device_definition({
  device_definition_id: "__string", # required
  name: "__string",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_definition_id (required, String)
  • :name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2414
2415
2416
2417
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2414

def update_device_definition(params = {}, options = {})
  req = build_request(:update_device_definition, params)
  req.send_request(options)
end

#update_function_definition(params = {}) ⇒ Struct

Updates a Lambda function definition.

Examples:

Request syntax with placeholder values


resp = client.update_function_definition({
  function_definition_id: "__string", # required
  name: "__string",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :function_definition_id (required, String)
  • :name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2438
2439
2440
2441
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2438

def update_function_definition(params = {}, options = {})
  req = build_request(:update_function_definition, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ Struct

Updates a group.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_id: "__string", # required
  name: "__string",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (required, String)
  • :name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2462
2463
2464
2465
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2462

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_group_certificate_configuration(params = {}) ⇒ Types::UpdateGroupCertificateConfigurationResponse

Updates the Cert expiry time for a group.

Examples:

Request syntax with placeholder values


resp = client.update_group_certificate_configuration({
  certificate_expiry_in_milliseconds: "__string",
  group_id: "__string", # required
})

Response structure


resp.certificate_authority_expiry_in_milliseconds #=> String
resp.certificate_expiry_in_milliseconds #=> String
resp.group_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_expiry_in_milliseconds (String)

    Amount of time when the certificate expires in milliseconds.

  • :group_id (required, String)

Returns:

See Also:



2497
2498
2499
2500
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2497

def update_group_certificate_configuration(params = {}, options = {})
  req = build_request(:update_group_certificate_configuration, params)
  req.send_request(options)
end

#update_logger_definition(params = {}) ⇒ Struct

Updates a logger definition.

Examples:

Request syntax with placeholder values


resp = client.update_logger_definition({
  logger_definition_id: "__string", # required
  name: "__string",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)
  • :name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2521
2522
2523
2524
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2521

def update_logger_definition(params = {}, options = {})
  req = build_request(:update_logger_definition, params)
  req.send_request(options)
end

#update_subscription_definition(params = {}) ⇒ Struct

Updates a subscription definition.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_definition({
  name: "__string",
  subscription_definition_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (String)
  • :subscription_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2545
2546
2547
2548
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2545

def update_subscription_definition(params = {}, options = {})
  req = build_request(:update_subscription_definition, params)
  req.send_request(options)
end