Class: Aws::Greengrass::Client

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

Overview

An API client for Greengrass. To construct a client, you need to configure a :region and :credentials.

client = Aws::Greengrass::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials 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 searched 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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :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 or custom endpoints. This should be a valid 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.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

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

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle 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.

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



324
325
326
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 324

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:



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

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:



391
392
393
394
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 391

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:



456
457
458
459
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 456

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:



504
505
506
507
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 504

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:



568
569
570
571
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 568

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:



615
616
617
618
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 615

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:



663
664
665
666
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 663

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:



726
727
728
729
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 726

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:



773
774
775
776
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 773

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:



872
873
874
875
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 872

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:



957
958
959
960
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 957

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:



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

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:



1052
1053
1054
1055
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1052

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:



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

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:



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

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:



1221
1222
1223
1224
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1221

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:



1320
1321
1322
1323
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1320

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:



1402
1403
1404
1405
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1402

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:



1464
1465
1466
1467
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1464

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:



1527
1528
1529
1530
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1527

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:



1574
1575
1576
1577
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1574

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:



1595
1596
1597
1598
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1595

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:



1616
1617
1618
1619
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1616

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:



1637
1638
1639
1640
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1637

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:



1658
1659
1660
1661
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1658

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:



1679
1680
1681
1682
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1679

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:



1700
1701
1702
1703
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1700

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:



1721
1722
1723
1724
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1721

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:



1742
1743
1744
1745
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1742

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:



1769
1770
1771
1772
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1769

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:



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

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:



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

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:



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

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



1893
1894
1895
1896
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1893

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:



1935
1936
1937
1938
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 1935

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:



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

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:



2027
2028
2029
2030
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2027

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:



2071
2072
2073
2074
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2071

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:



2111
2112
2113
2114
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2111

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:



2153
2154
2155
2156
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2153

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:



2200
2201
2202
2203
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2200

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:



2243
2244
2245
2246
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2243

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:



2308
2309
2310
2311
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2308

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:



2350
2351
2352
2353
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2350

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:



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

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:



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

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:



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

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:



2502
2503
2504
2505
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2502

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:



2548
2549
2550
2551
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2548

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:



2591
2592
2593
2594
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2591

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:



2650
2651
2652
2653
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2650

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:



2671
2672
2673
2674
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2671

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:



2713
2714
2715
2716
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2713

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:



2760
2761
2762
2763
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2760

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

#get_thing_runtime_configuration(params = {}) ⇒ Types::GetThingRuntimeConfigurationResponse

Get the runtime configuration of a thing.

Examples:

Request syntax with placeholder values


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

Response structure


resp.runtime_configuration.telemetry_configuration.configuration_sync_status #=> String, one of "InSync", "OutOfSync"
resp.runtime_configuration.telemetry_configuration.telemetry #=> String, one of "On", "Off"

Parameters:

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

    ({})

Options Hash (params):

  • :thing_name (required, String)

Returns:

See Also:



2788
2789
2790
2791
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2788

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



2834
2835
2836
2837
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2834

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:



2869
2870
2871
2872
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2869

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:



2911
2912
2913
2914
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2911

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:



2952
2953
2954
2955
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2952

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:



2991
2992
2993
2994
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 2991

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:



3032
3033
3034
3035
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3032

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:



3072
3073
3074
3075
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3072

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:



3111
3112
3113
3114
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3111

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:



3152
3153
3154
3155
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3152

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:



3191
3192
3193
3194
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3191

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:



3232
3233
3234
3235
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3232

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:



3261
3262
3263
3264
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3261

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:



3300
3301
3302
3303
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3300

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:



3339
3340
3341
3342
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3339

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:



3378
3379
3380
3381
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3378

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:



3419
3420
3421
3422
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3419

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:



3458
3459
3460
3461
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3458

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:



3499
3500
3501
3502
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3499

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:



3538
3539
3540
3541
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3538

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:



3579
3580
3581
3582
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3579

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:



3607
3608
3609
3610
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3607

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:



3643
3644
3645
3646
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3643

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:



3702
3703
3704
3705
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3702

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:



3727
3728
3729
3730
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3727

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:



3758
3759
3760
3761
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3758

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:



3782
3783
3784
3785
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3782

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:



3824
3825
3826
3827
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3824

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:



3848
3849
3850
3851
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3848

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:



3872
3873
3874
3875
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3872

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:



3896
3897
3898
3899
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3896

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:



3920
3921
3922
3923
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3920

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:



3944
3945
3946
3947
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3944

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:



3980
3981
3982
3983
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 3980

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:



4004
4005
4006
4007
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 4004

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:



4028
4029
4030
4031
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 4028

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:



4052
4053
4054
4055
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 4052

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

#update_thing_runtime_configuration(params = {}) ⇒ Struct

Updates the runtime configuration of a thing.

Examples:

Request syntax with placeholder values


resp = client.update_thing_runtime_configuration({
  telemetry_configuration: {
    telemetry: "On", # required, accepts On, Off
  },
  thing_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4079
4080
4081
4082
 
# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/client.rb', line 4079

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