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

#api_requests, #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(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.associated_at #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The ARN of the role you wish to associate with this group. The existence of the role is not validated.

Returns:

See Also:



286
287
288
289
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 286

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 with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

Examples:

Request syntax with placeholder values


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

Response structure


resp.associated_at #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :role_arn (required, String)

    The ARN of the service role you wish to associate with your account.

Returns:

See Also:



318
319
320
321
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 318

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

#create_connector_definition(params = {}) ⇒ Types::CreateConnectorDefinitionResponse

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

Examples:

Request syntax with placeholder values


resp = client.create_connector_definition({
  amzn_client_token: "__string",
  initial_version: {
    connectors: [
      {
        connector_arn: "__string", # required
        id: "__string", # required
        parameters: {
          "__string" => "__string",
        },
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::ConnectorDefinitionVersion)

    Information about the connector definition version, which is a container for connectors.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



383
384
385
386
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 383

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

#create_connector_definition_version(params = {}) ⇒ Types::CreateConnectorDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_connector_definition_version({
  amzn_client_token: "__string",
  connector_definition_id: "__string", # required
  connectors: [
    {
      connector_arn: "__string", # required
      id: "__string", # required
      parameters: {
        "__string" => "__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)
  • :connector_definition_id (required, String)
  • :connectors (Array<Types::Connector>)

Returns:

See Also:



431
432
433
434
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 431

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

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

Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

Examples:

Request syntax with placeholder values


resp = client.create_core_definition({
  amzn_client_token: "__string",
  initial_version: {
    cores: [
      {
        certificate_arn: "__string", # required
        id: "__string", # required
        sync_shadow: false,
        thing_arn: "__string", # required
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::CoreDefinitionVersion)

    Information about a core definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



495
496
497
498
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 495

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. Greengrass groups must each contain exactly one 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", # required
      id: "__string", # required
      sync_shadow: false,
      thing_arn: "__string", # required
    },
  ],
})

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:



542
543
544
545
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 542

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. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  amzn_client_token: "__string",
  deployment_id: "__string",
  deployment_type: "NewDeployment", # required, accepts NewDeployment, Redeployment, ResetDeployment, ForceResetDeployment
  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)

    The ID of the deployment if you wish to redeploy a previous deployment.

  • :deployment_type (required, String)

    The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

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

    The ID of the group version to be deployed.

Returns:

See Also:



590
591
592
593
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 590

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 provide the initial version of the device definition now 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", # required
        id: "__string", # required
        sync_shadow: false,
        thing_arn: "__string", # required
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::DeviceDefinitionVersion)

    Information about a device definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



653
654
655
656
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 653

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", # required
      id: "__string", # required
      sync_shadow: false,
      thing_arn: "__string", # required
    },
  ],
})

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:



700
701
702
703
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 700

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: {
    default_config: {
      execution: {
        isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
        run_as: {
          gid: 1,
          uid: 1,
        },
      },
    },
    functions: [
      {
        function_arn: "__string",
        function_configuration: {
          encoding_type: "binary", # accepts binary, json
          environment: {
            access_sysfs: false,
            execution: {
              isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
              run_as: {
                gid: 1,
                uid: 1,
              },
            },
            resource_access_policies: [
              {
                permission: "ro", # accepts ro, rw
                resource_id: "__string", # required
              },
            ],
            variables: {
              "__string" => "__string",
            },
          },
          exec_args: "__string",
          executable: "__string",
          memory_size: 1,
          pinned: false,
          timeout: 1,
        },
        id: "__string", # required
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::FunctionDefinitionVersion)

    Information about a function definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



799
800
801
802
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 799

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

Creates 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",
  default_config: {
    execution: {
      isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
      run_as: {
        gid: 1,
        uid: 1,
      },
    },
  },
  function_definition_id: "__string", # required
  functions: [
    {
      function_arn: "__string",
      function_configuration: {
        encoding_type: "binary", # accepts binary, json
        environment: {
          access_sysfs: false,
          execution: {
            isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
            run_as: {
              gid: 1,
              uid: 1,
            },
          },
          resource_access_policies: [
            {
              permission: "ro", # accepts ro, rw
              resource_id: "__string", # required
            },
          ],
          variables: {
            "__string" => "__string",
          },
        },
        exec_args: "__string",
        executable: "__string",
        memory_size: 1,
        pinned: false,
        timeout: 1,
      },
      id: "__string", # required
    },
  ],
})

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)
  • :default_config (Types::FunctionDefaultConfig)

    The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.

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

Returns:

See Also:



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

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 provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  amzn_client_token: "__string",
  initial_version: {
    connector_definition_version_arn: "__string",
    core_definition_version_arn: "__string",
    device_definition_version_arn: "__string",
    function_definition_version_arn: "__string",
    logger_definition_version_arn: "__string",
    resource_definition_version_arn: "__string",
    subscription_definition_version_arn: "__string",
  },
  name: "__string",
  tags: {
    "__string" => "__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 about a group version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



948
949
950
951
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 948

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:



979
980
981
982
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 979

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",
  connector_definition_version_arn: "__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",
  resource_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)
  • :connector_definition_version_arn (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)
  • :resource_definition_version_arn (String)
  • :subscription_definition_version_arn (String)

Returns:

See Also:



1036
1037
1038
1039
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1036

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 provide the initial version of the logger definition now 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", # required, accepts GreengrassSystem, Lambda
        id: "__string", # required
        level: "DEBUG", # required, accepts DEBUG, INFO, WARN, ERROR, FATAL
        space: 1,
        type: "FileSystem", # required, accepts FileSystem, AWSCloudWatch
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::LoggerDefinitionVersion)

    Information about a logger definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



1100
1101
1102
1103
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1100

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", # required, accepts GreengrassSystem, Lambda
      id: "__string", # required
      level: "DEBUG", # required, accepts DEBUG, INFO, WARN, ERROR, FATAL
      space: 1,
      type: "FileSystem", # required, 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:



1148
1149
1150
1151
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1148

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

#create_resource_definition(params = {}) ⇒ Types::CreateResourceDefinitionResponse

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later.

Examples:

Request syntax with placeholder values


resp = client.create_resource_definition({
  amzn_client_token: "__string",
  initial_version: {
    resources: [
      {
        id: "__string", # required
        name: "__string", # required
        resource_data_container: { # required
          local_device_resource_data: {
            group_owner_setting: {
              auto_add_group_owner: false,
              group_owner: "__string",
            },
            source_path: "__string",
          },
          local_volume_resource_data: {
            destination_path: "__string",
            group_owner_setting: {
              auto_add_group_owner: false,
              group_owner: "__string",
            },
            source_path: "__string",
          },
          s3_machine_learning_model_resource_data: {
            destination_path: "__string",
            owner_setting: {
              group_owner: "__string", # required
              group_permission: "ro", # required, accepts ro, rw
            },
            s3_uri: "__string",
          },
          sage_maker_machine_learning_model_resource_data: {
            destination_path: "__string",
            owner_setting: {
              group_owner: "__string", # required
              group_permission: "ro", # required, accepts ro, rw
            },
            sage_maker_job_arn: "__string",
          },
          secrets_manager_secret_resource_data: {
            arn: "__string",
            additional_staging_labels_to_download: ["__string"],
          },
        },
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::ResourceDefinitionVersion)

    Information about a resource definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



1247
1248
1249
1250
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1247

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

#create_resource_definition_version(params = {}) ⇒ Types::CreateResourceDefinitionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_resource_definition_version({
  amzn_client_token: "__string",
  resource_definition_id: "__string", # required
  resources: [
    {
      id: "__string", # required
      name: "__string", # required
      resource_data_container: { # required
        local_device_resource_data: {
          group_owner_setting: {
            auto_add_group_owner: false,
            group_owner: "__string",
          },
          source_path: "__string",
        },
        local_volume_resource_data: {
          destination_path: "__string",
          group_owner_setting: {
            auto_add_group_owner: false,
            group_owner: "__string",
          },
          source_path: "__string",
        },
        s3_machine_learning_model_resource_data: {
          destination_path: "__string",
          owner_setting: {
            group_owner: "__string", # required
            group_permission: "ro", # required, accepts ro, rw
          },
          s3_uri: "__string",
        },
        sage_maker_machine_learning_model_resource_data: {
          destination_path: "__string",
          owner_setting: {
            group_owner: "__string", # required
            group_permission: "ro", # required, accepts ro, rw
          },
          sage_maker_job_arn: "__string",
        },
        secrets_manager_secret_resource_data: {
          arn: "__string",
          additional_staging_labels_to_download: ["__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)
  • :resource_definition_id (required, String)
  • :resources (Array<Types::Resource>)

Returns:

See Also:



1329
1330
1331
1332
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1329

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

#create_software_update_job(params = {}) ⇒ Types::CreateSoftwareUpdateJobResponse

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Examples:

Request syntax with placeholder values


resp = client.create_software_update_job({
  amzn_client_token: "__string",
  s3_url_signer_role: "S3UrlSignerRole", # required
  software_to_update: "core", # required, accepts core, ota_agent
  update_agent_log_level: "NONE", # accepts NONE, TRACE, DEBUG, VERBOSE, INFO, WARN, ERROR, FATAL
  update_targets: ["__string"], # required
  update_targets_architecture: "armv6l", # required, accepts armv6l, armv7l, x86_64, aarch64
  update_targets_operating_system: "ubuntu", # required, accepts ubuntu, raspbian, amazon_linux, openwrt
})

Response structure


resp.iot_job_arn #=> String
resp.iot_job_id #=> String
resp.platform_software_version #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.

  • :software_to_update (required, String)

    The piece of software on the Greengrass core that will be updated.

  • :update_agent_log_level (String)

    The minimum level of log statements that should be logged by the OTA Agent during an update.

  • :update_targets (required, Array<String>)

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

  • :update_targets_architecture (required, String)

    The architecture of the cores which are the targets of an update.

  • :update_targets_operating_system (required, String)

    The operating system of the cores which are the targets of an update.

Returns:

See Also:



1391
1392
1393
1394
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1391

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

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

Creates a subscription definition. You may provide the initial version of the subscription definition now 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", # required
        source: "__string", # required
        subject: "__string", # required
        target: "__string", # required
      },
    ],
  },
  name: "__string",
  tags: {
    "__string" => "__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::SubscriptionDefinitionVersion)

    Information about a subscription definition version.

  • :name (String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



1454
1455
1456
1457
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1454

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", # required
      source: "__string", # required
      subject: "__string", # required
      target: "__string", # required
    },
  ],
})

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:



1501
1502
1503
1504
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1501

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

#delete_connector_definition(params = {}) ⇒ Struct

Deletes a connector definition.

Examples:

Request syntax with placeholder values


resp = client.delete_connector_definition({
  connector_definition_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :connector_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1522
1523
1524
1525
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1522

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

#delete_core_definition(params = {}) ⇒ Struct

Deletes a core definition.

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:



1543
1544
1545
1546
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1543

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.

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:



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

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.

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:



1585
1586
1587
1588
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1585

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.

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:



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

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.

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:



1627
1628
1629
1630
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1627

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

#delete_resource_definition(params = {}) ⇒ Struct

Deletes a resource definition.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_definition({
  resource_definition_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_definition_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1648
1649
1650
1651
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1648

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

#delete_subscription_definition(params = {}) ⇒ Struct

Deletes a subscription definition.

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:



1669
1670
1671
1672
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1669

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:



1696
1697
1698
1699
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1696

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 your account. Without a service role, deployments will not work.

Examples:

Response structure


resp.disassociated_at #=> String

Parameters:

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

    ({})

Returns:

See Also:



1716
1717
1718
1719
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1716

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:



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

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

#get_bulk_deployment_status(params = {}) ⇒ Types::GetBulkDeploymentStatusResponse

Returns the status of a bulk deployment.

Examples:

Request syntax with placeholder values


resp = client.get_bulk_deployment_status({
  bulk_deployment_id: "__string", # required
})

Response structure


resp.bulk_deployment_metrics.invalid_input_records #=> Integer
resp.bulk_deployment_metrics.records_processed #=> Integer
resp.bulk_deployment_metrics.retry_attempts #=> Integer
resp.bulk_deployment_status #=> String, one of "Initializing", "Running", "Completed", "Stopping", "Stopped", "Failed"
resp.created_at #=> String
resp.error_details #=> Array
resp.error_details[0].detailed_error_code #=> String
resp.error_details[0].detailed_error_message #=> String
resp.error_message #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bulk_deployment_id (required, String)

Returns:

See Also:



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

def get_bulk_deployment_status(params = {}, options = {})
  req = build_request(:get_bulk_deployment_status, 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:



1820
1821
1822
1823
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1820

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

#get_connector_definition(params = {}) ⇒ Types::GetConnectorDefinitionResponse

Retrieves information about a connector definition.

Examples:

Request syntax with placeholder values


resp = client.get_connector_definition({
  connector_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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connector_definition_id (required, String)

Returns:

See Also:



1862
1863
1864
1865
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1862

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

#get_connector_definition_version(params = {}) ⇒ Types::GetConnectorDefinitionVersionResponse

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

Examples:

Request syntax with placeholder values


resp = client.get_connector_definition_version({
  connector_definition_id: "__string", # required
  connector_definition_version_id: "__string", # required
  next_token: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.connectors #=> Array
resp.definition.connectors[0].connector_arn #=> String
resp.definition.connectors[0].id #=> String
resp.definition.connectors[0].parameters #=> Hash
resp.definition.connectors[0].parameters["__string"] #=> String
resp.id #=> String
resp.next_token #=> String
resp.version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connector_definition_id (required, String)
  • :connector_definition_version_id (required, String)
  • :next_token (String)

Returns:

See Also:



1912
1913
1914
1915
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1912

def get_connector_definition_version(params = {}, options = {})
  req = build_request(:get_connector_definition_version, 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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_definition_id (required, String)

Returns:

See Also:



1954
1955
1956
1957
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1954

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.next_token #=> 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:



1998
1999
2000
2001
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1998

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.deployment_type #=> String, one of "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"
resp.error_details #=> Array
resp.error_details[0].detailed_error_code #=> String
resp.error_details[0].detailed_error_message #=> 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:



2038
2039
2040
2041
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2038

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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :device_definition_id (required, String)

Returns:

See Also:



2080
2081
2082
2083
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2080

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
  next_token: "__string",
})

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.next_token #=> String
resp.version #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



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

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, including 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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_definition_id (required, String)

Returns:

See Also:



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

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, including 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
  next_token: "__string",
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.default_config.execution.isolation_mode #=> String, one of "GreengrassContainer", "NoContainer"
resp.definition.default_config.execution.run_as.gid #=> Integer
resp.definition.default_config.execution.run_as.uid #=> Integer
resp.definition.functions #=> Array
resp.definition.functions[0].function_arn #=> String
resp.definition.functions[0].function_configuration.encoding_type #=> String, one of "binary", "json"
resp.definition.functions[0].function_configuration.environment.access_sysfs #=> Boolean
resp.definition.functions[0].function_configuration.environment.execution.isolation_mode #=> String, one of "GreengrassContainer", "NoContainer"
resp.definition.functions[0].function_configuration.environment.execution.run_as.gid #=> Integer
resp.definition.functions[0].function_configuration.environment.execution.run_as.uid #=> Integer
resp.definition.functions[0].function_configuration.environment.resource_access_policies #=> Array
resp.definition.functions[0].function_configuration.environment.resource_access_policies[0].permission #=> String, one of "ro", "rw"
resp.definition.functions[0].function_configuration.environment.resource_access_policies[0].resource_id #=> 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.next_token #=> String
resp.version #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2235
2236
2237
2238
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2235

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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_id (required, String)

Returns:

See Also:



2277
2278
2279
2280
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2277

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:



2312
2313
2314
2315
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2312

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:



2343
2344
2345
2346
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2343

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.connector_definition_version_arn #=> 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.resource_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:



2387
2388
2389
2390
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2387

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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :logger_definition_id (required, String)

Returns:

See Also:



2429
2430
2431
2432
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2429

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
  next_token: "__string",
})

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)
  • :next_token (String)

Returns:

See Also:



2475
2476
2477
2478
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2475

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

#get_resource_definition(params = {}) ⇒ Types::GetResourceDefinitionResponse

Retrieves information about a resource definition, including its creation time and latest version.

Examples:

Request syntax with placeholder values


resp = client.get_resource_definition({
  resource_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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_definition_id (required, String)

Returns:

See Also:



2518
2519
2520
2521
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2518

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

#get_resource_definition_version(params = {}) ⇒ Types::GetResourceDefinitionVersionResponse

Retrieves information about a resource definition version, including which resources are included in the version.

Examples:

Request syntax with placeholder values


resp = client.get_resource_definition_version({
  resource_definition_id: "__string", # required
  resource_definition_version_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_timestamp #=> String
resp.definition.resources #=> Array
resp.definition.resources[0].id #=> String
resp.definition.resources[0].name #=> String
resp.definition.resources[0].resource_data_container.local_device_resource_data.group_owner_setting.auto_add_group_owner #=> Boolean
resp.definition.resources[0].resource_data_container.local_device_resource_data.group_owner_setting.group_owner #=> String
resp.definition.resources[0].resource_data_container.local_device_resource_data.source_path #=> String
resp.definition.resources[0].resource_data_container.local_volume_resource_data.destination_path #=> String
resp.definition.resources[0].resource_data_container.local_volume_resource_data.group_owner_setting.auto_add_group_owner #=> Boolean
resp.definition.resources[0].resource_data_container.local_volume_resource_data.group_owner_setting.group_owner #=> String
resp.definition.resources[0].resource_data_container.local_volume_resource_data.source_path #=> String
resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.destination_path #=> String
resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.owner_setting.group_owner #=> String
resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.owner_setting.group_permission #=> String, one of "ro", "rw"
resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.s3_uri #=> String
resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.destination_path #=> String
resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.owner_setting.group_owner #=> String
resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.owner_setting.group_permission #=> String, one of "ro", "rw"
resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.sage_maker_job_arn #=> String
resp.definition.resources[0].resource_data_container.secrets_manager_secret_resource_data.arn #=> String
resp.definition.resources[0].resource_data_container.secrets_manager_secret_resource_data.additional_staging_labels_to_download #=> Array
resp.definition.resources[0].resource_data_container.secrets_manager_secret_resource_data.additional_staging_labels_to_download[0] #=> String
resp.id #=> String
resp.version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_definition_id (required, String)
  • :resource_definition_version_id (required, String)

Returns:

See Also:



2577
2578
2579
2580
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2577

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

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

Retrieves the service role that is attached to your account.

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



2598
2599
2600
2601
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2598

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
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :subscription_definition_id (required, String)

Returns:

See Also:



2640
2641
2642
2643
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2640

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({
  next_token: "__string",
  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.next_token #=> String
resp.version #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2687
2688
2689
2690
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2687

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

#list_bulk_deployment_detailed_reports(params = {}) ⇒ Types::ListBulkDeploymentDetailedReportsResponse

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Examples:

Request syntax with placeholder values


resp = client.list_bulk_deployment_detailed_reports({
  bulk_deployment_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].deployment_status #=> String
resp.deployments[0].deployment_type #=> String, one of "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"
resp.deployments[0].error_details #=> Array
resp.deployments[0].error_details[0].detailed_error_code #=> String
resp.deployments[0].error_details[0].detailed_error_message #=> String
resp.deployments[0].error_message #=> String
resp.deployments[0].group_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2733
2734
2735
2736
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2733

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

#list_bulk_deployments(params = {}) ⇒ Types::ListBulkDeploymentsResponse

Returns a list of bulk deployments.

Examples:

Request syntax with placeholder values


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

Response structure


resp.bulk_deployments #=> Array
resp.bulk_deployments[0].bulk_deployment_arn #=> String
resp.bulk_deployments[0].bulk_deployment_id #=> String
resp.bulk_deployments[0].created_at #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2768
2769
2770
2771
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2768

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

#list_connector_definition_versions(params = {}) ⇒ Types::ListConnectorDefinitionVersionsResponse

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

Examples:

Request syntax with placeholder values


resp = client.list_connector_definition_versions({
  connector_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):

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

Returns:

See Also:



2810
2811
2812
2813
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2810

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

#list_connector_definitions(params = {}) ⇒ Types::ListConnectorDefinitionsResponse

Retrieves a list of connector definitions.

Examples:

Request syntax with placeholder values


resp = client.list_connector_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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2851
2852
2853
2854
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2851

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

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

Lists the 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:



2890
2891
2892
2893
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2890

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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



2931
2932
2933
2934
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2931

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].deployment_type #=> String, one of "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"
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:



2971
2972
2973
2974
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2971

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:



3010
3011
3012
3013
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3010

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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



3051
3052
3053
3054
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3051

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:



3090
3091
3092
3093
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3090

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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



3131
3132
3133
3134
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3131

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:



3160
3161
3162
3163
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3160

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

Lists 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:



3199
3200
3201
3202
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3199

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:



3238
3239
3240
3241
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3238

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:



3277
3278
3279
3280
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3277

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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



3318
3319
3320
3321
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3318

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

#list_resource_definition_versions(params = {}) ⇒ Types::ListResourceDefinitionVersionsResponse

Lists the versions of a resource definition.

Examples:

Request syntax with placeholder values


resp = client.list_resource_definition_versions({
  max_results: "__string",
  next_token: "__string",
  resource_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)
  • :resource_definition_id (required, String)

Returns:

See Also:



3357
3358
3359
3360
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3357

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

#list_resource_definitions(params = {}) ⇒ Types::ListResourceDefinitionsResponse

Retrieves a list of resource definitions.

Examples:

Request syntax with placeholder values


resp = client.list_resource_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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



3398
3399
3400
3401
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3398

def list_resource_definitions(params = {}, options = {})
  req = build_request(:list_resource_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:



3437
3438
3439
3440
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3437

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.definitions[0].tags #=> Hash
resp.definitions[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



3478
3479
3480
3481
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3478

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves a list of resource tags for a resource arn.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



3506
3507
3508
3509
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3506

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

#reset_deployments(params = {}) ⇒ Types::ResetDeploymentsResponse

Resets a group's deployments.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :amzn_client_token (String)
  • :force (Boolean)

    If true, performs a best-effort only core reset.

  • :group_id (required, String)

Returns:

See Also:



3542
3543
3544
3545
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3542

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

#start_bulk_deployment(params = {}) ⇒ Types::StartBulkDeploymentResponse

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

Examples:

Request syntax with placeholder values


resp = client.start_bulk_deployment({
  amzn_client_token: "__string",
  execution_role_arn: "__string", # required
  input_file_uri: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.bulk_deployment_arn #=> String
resp.bulk_deployment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

  • :input_file_uri (required, String)

    The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

See Also:



3601
3602
3603
3604
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3601

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

#stop_bulk_deployment(params = {}) ⇒ Struct

Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

Examples:

Request syntax with placeholder values


resp = client.stop_bulk_deployment({
  bulk_deployment_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :bulk_deployment_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3626
3627
3628
3629
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3626

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags (Hash<String,String>)

    The key-value pair for the resource tag.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3657
3658
3659
3660
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3657

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

#untag_resource(params = {}) ⇒ Struct

Remove resource tags from a Greengrass Resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3681
3682
3683
3684
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3681

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, 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):

  • :connectivity_info (Array<Types::ConnectivityInfo>)

    A list of connectivity info.

  • :thing_name (required, String)

Returns:

See Also:



3723
3724
3725
3726
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3723

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

#update_connector_definition(params = {}) ⇒ Struct

Updates a connector definition.

Examples:

Request syntax with placeholder values


resp = client.update_connector_definition({
  connector_definition_id: "__string", # required
  name: "__string",
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3747
3748
3749
3750
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3747

def update_connector_definition(params = {}, options = {})
  req = build_request(:update_connector_definition, 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:



3771
3772
3773
3774
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3771

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:



3795
3796
3797
3798
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3795

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:



3819
3820
3821
3822
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3819

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:



3843
3844
3845
3846
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3843

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

    The amount of time remaining before the certificate expires, in milliseconds.

  • :group_id (required, String)

Returns:

See Also:



3879
3880
3881
3882
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3879

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:



3903
3904
3905
3906
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3903

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

#update_resource_definition(params = {}) ⇒ Struct

Updates a resource definition.

Examples:

Request syntax with placeholder values


resp = client.update_resource_definition({
  name: "__string",
  resource_definition_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3927
3928
3929
3930
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3927

def update_resource_definition(params = {}, options = {})
  req = build_request(:update_resource_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:



3951
3952
3953
3954
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3951

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