Class: Aws::Greengrass::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-greengrass/client.rb,
sig/client.rbs

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.

Defined Under Namespace

Modules: _AssociateRoleToGroupResponseSuccess, _AssociateServiceRoleToAccountResponseSuccess, _CreateConnectorDefinitionResponseSuccess, _CreateConnectorDefinitionVersionResponseSuccess, _CreateCoreDefinitionResponseSuccess, _CreateCoreDefinitionVersionResponseSuccess, _CreateDeploymentResponseSuccess, _CreateDeviceDefinitionResponseSuccess, _CreateDeviceDefinitionVersionResponseSuccess, _CreateFunctionDefinitionResponseSuccess, _CreateFunctionDefinitionVersionResponseSuccess, _CreateGroupCertificateAuthorityResponseSuccess, _CreateGroupResponseSuccess, _CreateGroupVersionResponseSuccess, _CreateLoggerDefinitionResponseSuccess, _CreateLoggerDefinitionVersionResponseSuccess, _CreateResourceDefinitionResponseSuccess, _CreateResourceDefinitionVersionResponseSuccess, _CreateSoftwareUpdateJobResponseSuccess, _CreateSubscriptionDefinitionResponseSuccess, _CreateSubscriptionDefinitionVersionResponseSuccess, _DeleteConnectorDefinitionResponseSuccess, _DeleteCoreDefinitionResponseSuccess, _DeleteDeviceDefinitionResponseSuccess, _DeleteFunctionDefinitionResponseSuccess, _DeleteGroupResponseSuccess, _DeleteLoggerDefinitionResponseSuccess, _DeleteResourceDefinitionResponseSuccess, _DeleteSubscriptionDefinitionResponseSuccess, _DisassociateRoleFromGroupResponseSuccess, _DisassociateServiceRoleFromAccountResponseSuccess, _GetAssociatedRoleResponseSuccess, _GetBulkDeploymentStatusResponseSuccess, _GetConnectivityInfoResponseSuccess, _GetConnectorDefinitionResponseSuccess, _GetConnectorDefinitionVersionResponseSuccess, _GetCoreDefinitionResponseSuccess, _GetCoreDefinitionVersionResponseSuccess, _GetDeploymentStatusResponseSuccess, _GetDeviceDefinitionResponseSuccess, _GetDeviceDefinitionVersionResponseSuccess, _GetFunctionDefinitionResponseSuccess, _GetFunctionDefinitionVersionResponseSuccess, _GetGroupCertificateAuthorityResponseSuccess, _GetGroupCertificateConfigurationResponseSuccess, _GetGroupResponseSuccess, _GetGroupVersionResponseSuccess, _GetLoggerDefinitionResponseSuccess, _GetLoggerDefinitionVersionResponseSuccess, _GetResourceDefinitionResponseSuccess, _GetResourceDefinitionVersionResponseSuccess, _GetServiceRoleForAccountResponseSuccess, _GetSubscriptionDefinitionResponseSuccess, _GetSubscriptionDefinitionVersionResponseSuccess, _GetThingRuntimeConfigurationResponseSuccess, _ListBulkDeploymentDetailedReportsResponseSuccess, _ListBulkDeploymentsResponseSuccess, _ListConnectorDefinitionVersionsResponseSuccess, _ListConnectorDefinitionsResponseSuccess, _ListCoreDefinitionVersionsResponseSuccess, _ListCoreDefinitionsResponseSuccess, _ListDeploymentsResponseSuccess, _ListDeviceDefinitionVersionsResponseSuccess, _ListDeviceDefinitionsResponseSuccess, _ListFunctionDefinitionVersionsResponseSuccess, _ListFunctionDefinitionsResponseSuccess, _ListGroupCertificateAuthoritiesResponseSuccess, _ListGroupVersionsResponseSuccess, _ListGroupsResponseSuccess, _ListLoggerDefinitionVersionsResponseSuccess, _ListLoggerDefinitionsResponseSuccess, _ListResourceDefinitionVersionsResponseSuccess, _ListResourceDefinitionsResponseSuccess, _ListSubscriptionDefinitionVersionsResponseSuccess, _ListSubscriptionDefinitionsResponseSuccess, _ListTagsForResourceResponseSuccess, _ResetDeploymentsResponseSuccess, _StartBulkDeploymentResponseSuccess, _StopBulkDeploymentResponseSuccess, _UpdateConnectivityInfoResponseSuccess, _UpdateConnectorDefinitionResponseSuccess, _UpdateCoreDefinitionResponseSuccess, _UpdateDeviceDefinitionResponseSuccess, _UpdateFunctionDefinitionResponseSuccess, _UpdateGroupCertificateConfigurationResponseSuccess, _UpdateGroupResponseSuccess, _UpdateLoggerDefinitionResponseSuccess, _UpdateResourceDefinitionResponseSuccess, _UpdateSubscriptionDefinitionResponseSuccess, _UpdateThingRuntimeConfigurationResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:function) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  




  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or 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, :session_token, and
:account_id options.
      

      • 

    • 

      ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
      

      • 

    • 

      ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to
enable retries and extended timeouts. Instance profile credential fetching can be disabled by
setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
      

      • 

    
          
        
    • 
      
        
  • 
          :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)
          
            
          
          
        
    • 
      
        
  • 
          :account_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.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :defaults_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    See DefaultsModeConfiguration for a list of the
accepted modes and the configuration defaults that are included.
    
          
        
    • 
      
        
  • 
          :disable_host_prefix_injection
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'

    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ignore_configured_endpoint_urls
          (Boolean)
          
            
          
          
            — 
    Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :request_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

    • when_supported - (default) When set, a checksum will be
calculated for all request payloads of operations modeled with the
httpChecksum trait where requestChecksumRequired is true and/or a
requestAlgorithmMember is modeled.
      • 

    • when_required - When set, a checksum will only be calculated for
request payloads of operations modeled with the  httpChecksum trait where
requestChecksumRequired is true or where a requestAlgorithmMember
is modeled and supplied.
      • 

    
          
        
    • 
      
        
  • 
          :request_min_compression_size_bytes
          (Integer)
          
            
              — default:
              10240
            
          
          
            — 
    The minimum size in bytes that triggers compression for request
bodies. The value must be non-negative integer value between 0
and 10485780 bytes inclusive.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

    • when_supported - (default) When set, checksum validation is performed on all
response payloads of operations modeled with the httpChecksum trait where
responseAlgorithms is modeled, except when no modeled checksum algorithms
are supported.
      • 

    • when_required - When set, checksum validation is not performed on
response payloads of operations unless the checksum algorithm is supported and
the requestValidationModeMember member is set to ENABLED.
      • 

    
          
        
    • 
      
        
  • 
          :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 the 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 - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :sdk_ua_app_id
          (String)
          
            
          
          
            — 
    A unique and opaque application ID that is appended to the
User-Agent header as app/sdk_ua_app_id. It should have a
maximum length of 50. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk gem and then, pass in an instance of a
Aws::Telemetry::OTelProvider for telemetry provider.
      • 

    
          
        
    • 
      
        
  • 
          :token_provider
          (Aws::TokenProvider)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or instance of any one of the following classes:
    

      

    • 

      Aws::StaticTokenProvider - Used for configuring static, non-refreshing
tokens.
      

      • 

    • 

      Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an
access token generated from aws login.
      

      • 

    

    When :token_provider is not configured directly, the Aws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files.
    
          
        
    • 
      
        
  • 
          :use_dualstack_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, dualstack enabled endpoints (with .aws TLD)
will be used if available.
    
          
        
    • 
      
        
  • 
          :use_fips_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, fips compatible endpoints will be used if available.
When a fips region is used, the region is normalized and this config
is set to true.
    
          
        
    • 
      
        
  • 
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, request parameters are validated before
sending the request.
    
          
        
    • 
      
        
  • 
          :endpoint_provider
          (Aws::Greengrass::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::Greengrass::EndpointParameters.
    
          
        
    • 
      
        
  • 
          :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_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_open_timeout
          (Float)
          
            
              — default:
              15
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_proxy
          (URI::HTTP, String)
          
            
          
          
            — 
    A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :http_read_timeout
          (Float)
          
            
              — default:
              60
            
          
          
            — 
    The default number of seconds to wait for response data.
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.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


471
472
473

    		
    
      
# File 'lib/aws-sdk-greengrass/client.rb', line 471

def initialize(*args)
  super
end


    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


4265
4266
4267

    		
    
      
# File 'lib/aws-sdk-greengrass/client.rb', line 4265

def identifier
  @identifier
end


    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


4268
4269
4270

    		
    
      
# File 'lib/aws-sdk-greengrass/client.rb', line 4268

def errors_module
  Errors
end


    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Greengrass/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (


    		
  





    
  


  

    
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:

  



  

    
      


86

    		
    
      
# File 'sig/client.rbs', line 86

def associate_role_to_group: (


    		
  





    
      

  

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

  



  

    
      


97

    		
    
      
# File 'sig/client.rbs', line 97

def associate_service_role_to_account: (


    		
  





    
      

  

  
    #build_request(operation_name, params = {})  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  
Parameters:


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






  

    
      


4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254

    		
    
      
# File 'lib/aws-sdk-greengrass/client.rb', line 4238

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Greengrass')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-greengrass'
  context[:gem_version] = '1.100.0'
  Seahorse::Client::Request.new(handlers, context)
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:

  



  

    
      


113

    		
    
      
# File 'sig/client.rbs', line 113

def create_connector_definition: (


    		
  





    
      

  

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

  



  

    
      


137

    		
    
      
# File 'sig/client.rbs', line 137

def create_connector_definition_version: (


    		
  





    
      

  

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

  



  

    
      


161

    		
    
      
# File 'sig/client.rbs', line 161

def create_core_definition: (


    		
  





    
      

  

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

  



  

    
      


186

    		
    
      
# File 'sig/client.rbs', line 186

def create_core_definition_version: (


    		
  





    
      

  

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

  



  

    
      


206

    		
    
      
# File 'sig/client.rbs', line 206

def create_deployment: (


    		
  





    
      

  

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

  



  

    
      


226

    		
    
      
# File 'sig/client.rbs', line 226

def create_device_definition: (


    		
  





    
      

  

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

  



  

    
      


251

    		
    
      
# File 'sig/client.rbs', line 251

def create_device_definition_version: (


    		
  





    
      

  

  
    #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,
          function_runtime_override: "__string",
        },
        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:

  



  

    
      


276

    		
    
      
# File 'sig/client.rbs', line 276

def create_function_definition: (


    		
  





    
      

  

  
    #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,
        function_runtime_override: "__string",
      },
      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:

  



  

    
      


297

    		
    
      
# File 'sig/client.rbs', line 297

def create_function_definition_version: (


    		
  





    
      

  

  
    #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", # required
  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
          (required, String)
          
            
          
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    The key-value pair for the resource tag.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


318

    		
    
      
# File 'sig/client.rbs', line 318

def create_group: (


    		
  





    
      

  

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

  



  

    
      


339

    		
    
      
# File 'sig/client.rbs', line 339

def create_group_certificate_authority: (


    		
  





    
      

  

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

  



  

    
      


353

    		
    
      
# File 'sig/client.rbs', line 353

def create_group_version: (


    		
  





    
      

  

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

  



  

    
      


377

    		
    
      
# File 'sig/client.rbs', line 377

def create_logger_definition: (


    		
  





    
      

  

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

  



  

    
      


403

    		
    
      
# File 'sig/client.rbs', line 403

def create_logger_definition_version: (


    		
  





    
      

  

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

  



  

    
      


429

    		
    
      
# File 'sig/client.rbs', line 429

def create_resource_definition: (


    		
  





    
      

  

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

  



  

    
      


449

    		
    
      
# File 'sig/client.rbs', line 449

def create_resource_definition_version: (


    		
  





    
      

  

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

  



  

    
      


465

    		
    
      
# File 'sig/client.rbs', line 465

def create_software_update_job: (


    		
  





    
      

  

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

  



  

    
      


487

    		
    
      
# File 'sig/client.rbs', line 487

def create_subscription_definition: (


    		
  





    
      

  

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

  



  

    
      


512

    		
    
      
# File 'sig/client.rbs', line 512

def create_subscription_definition_version: (


    		
  





    
      

  

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

  



  

    
      


530

    		
    
      
# File 'sig/client.rbs', line 530

def delete_connector_definition: (


    		
  





    
      

  

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

  



  

    
      


539

    		
    
      
# File 'sig/client.rbs', line 539

def delete_core_definition: (


    		
  





    
      

  

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

  



  

    
      


548

    		
    
      
# File 'sig/client.rbs', line 548

def delete_device_definition: (


    		
  





    
      

  

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

  



  

    
      


557

    		
    
      
# File 'sig/client.rbs', line 557

def delete_function_definition: (


    		
  





    
      

  

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

  



  

    
      


566

    		
    
      
# File 'sig/client.rbs', line 566

def delete_group: (


    		
  





    
      

  

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

  



  

    
      


575

    		
    
      
# File 'sig/client.rbs', line 575

def delete_logger_definition: (


    		
  





    
      

  

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

  



  

    
      


584

    		
    
      
# File 'sig/client.rbs', line 584

def delete_resource_definition: (


    		
  





    
      

  

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

  



  

    
      


593

    		
    
      
# File 'sig/client.rbs', line 593

def delete_subscription_definition: (


    		
  





    
      

  

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

  



  

    
      


603

    		
    
      
# File 'sig/client.rbs', line 603

def disassociate_role_from_group: (


    		
  





    
      

  

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

  



  

    
      


613

    		
    
      
# File 'sig/client.rbs', line 613

def disassociate_service_role_from_account: (


    		
  





    
      

  

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

  



  

    
      


623

    		
    
      
# File 'sig/client.rbs', line 623

def get_associated_role: (


    		
  





    
      

  

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

  



  

    
      


638

    		
    
      
# File 'sig/client.rbs', line 638

def get_bulk_deployment_status: (


    		
  





    
      

  

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

  



  

    
      


649

    		
    
      
# File 'sig/client.rbs', line 649

def get_connectivity_info: (


    		
  





    
      

  

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

  



  

    
      


666

    		
    
      
# File 'sig/client.rbs', line 666

def get_connector_definition: (


    		
  





    
      

  

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

  



  

    
      


681

    		
    
      
# File 'sig/client.rbs', line 681

def get_connector_definition_version: (


    		
  





    
      

  

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

  



  

    
      


700

    		
    
      
# File 'sig/client.rbs', line 700

def get_core_definition: (


    		
  





    
      

  

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

  



  

    
      


715

    		
    
      
# File 'sig/client.rbs', line 715

def get_core_definition_version: (


    		
  





    
      

  

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

  



  

    
      


730

    		
    
      
# File 'sig/client.rbs', line 730

def get_deployment_status: (


    		
  





    
      

  

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

  



  

    
      


748

    		
    
      
# File 'sig/client.rbs', line 748

def get_device_definition: (


    		
  





    
      

  

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

  



  

    
      


763

    		
    
      
# File 'sig/client.rbs', line 763

def get_device_definition_version: (


    		
  





    
      

  

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

  



  

    
      


782

    		
    
      
# File 'sig/client.rbs', line 782

def get_function_definition: (


    		
  





    
      

  

  
    #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].function_configuration.function_runtime_override #=> String
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:

  



  

    
      


797

    		
    
      
# File 'sig/client.rbs', line 797

def get_function_definition_version: (


    		
  





    
      

  

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

  



  

    
      


816

    		
    
      
# File 'sig/client.rbs', line 816

def get_group: (


    		
  





    
      

  

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

  



  

    
      


828

    		
    
      
# File 'sig/client.rbs', line 828

def get_group_certificate_authority: (


    		
  





    
      

  

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

  



  

    
      


841

    		
    
      
# File 'sig/client.rbs', line 841

def get_group_certificate_configuration: (


    		
  





    
      

  

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

  



  

    
      


855

    		
    
      
# File 'sig/client.rbs', line 855

def get_group_version: (


    		
  





    
      

  

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

  



  

    
      


873

    		
    
      
# File 'sig/client.rbs', line 873

def get_logger_definition: (


    		
  





    
      

  

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

  



  

    
      


887

    		
    
      
# File 'sig/client.rbs', line 887

def get_logger_definition_version: (


    		
  





    
      

  

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

  



  

    
      


906

    		
    
      
# File 'sig/client.rbs', line 906

def get_resource_definition: (


    		
  





    
      

  

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

  



  

    
      


920

    		
    
      
# File 'sig/client.rbs', line 920

def get_resource_definition_version: (


    		
  





    
      

  

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

  



  

    
      


932

    		
    
      
# File 'sig/client.rbs', line 932

def get_service_role_for_account: (


    		
  





    
      

  

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

  



  

    
      


948

    		
    
      
# File 'sig/client.rbs', line 948

def get_subscription_definition: (


    		
  





    
      

  

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

  



  

    
      


963

    		
    
      
# File 'sig/client.rbs', line 963

def get_subscription_definition_version: (


    		
  





    
      

  

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

  



  

    
      


975

    		
    
      
# File 'sig/client.rbs', line 975

def get_thing_runtime_configuration: (


    		
  





    
      

  

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

  



  

    
      


986

    		
    
      
# File 'sig/client.rbs', line 986

def list_bulk_deployment_detailed_reports: (


    		
  





    
      

  

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

  



  

    
      


999

    		
    
      
# File 'sig/client.rbs', line 999

def list_bulk_deployments: (


    		
  





    
      

  

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

  



  

    
      


1011

    		
    
      
# File 'sig/client.rbs', line 1011

def list_connector_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1024

    		
    
      
# File 'sig/client.rbs', line 1024

def list_connector_definitions: (


    		
  





    
      

  

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

  



  

    
      


1036

    		
    
      
# File 'sig/client.rbs', line 1036

def list_core_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1049

    		
    
      
# File 'sig/client.rbs', line 1049

def list_core_definitions: (


    		
  





    
      

  

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

  



  

    
      


1061

    		
    
      
# File 'sig/client.rbs', line 1061

def list_deployments: (


    		
  





    
      

  

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

  



  

    
      


1074

    		
    
      
# File 'sig/client.rbs', line 1074

def list_device_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1087

    		
    
      
# File 'sig/client.rbs', line 1087

def list_device_definitions: (


    		
  





    
      

  

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

  



  

    
      


1099

    		
    
      
# File 'sig/client.rbs', line 1099

def list_function_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1112

    		
    
      
# File 'sig/client.rbs', line 1112

def list_function_definitions: (


    		
  





    
      

  

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

  



  

    
      


1123

    		
    
      
# File 'sig/client.rbs', line 1123

def list_group_certificate_authorities: (


    		
  





    
      

  

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

  



  

    
      


1134

    		
    
      
# File 'sig/client.rbs', line 1134

def list_group_versions: (


    		
  





    
      

  

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

  



  

    
      


1147

    		
    
      
# File 'sig/client.rbs', line 1147

def list_groups: (


    		
  





    
      

  

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

  



  

    
      


1159

    		
    
      
# File 'sig/client.rbs', line 1159

def list_logger_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1172

    		
    
      
# File 'sig/client.rbs', line 1172

def list_logger_definitions: (


    		
  





    
      

  

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

  



  

    
      


1184

    		
    
      
# File 'sig/client.rbs', line 1184

def list_resource_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1197

    		
    
      
# File 'sig/client.rbs', line 1197

def list_resource_definitions: (


    		
  





    
      

  

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

  



  

    
      


1209

    		
    
      
# File 'sig/client.rbs', line 1209

def list_subscription_definition_versions: (


    		
  





    
      

  

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

  



  

    
      


1222

    		
    
      
# File 'sig/client.rbs', line 1222

def list_subscription_definitions: (


    		
  





    
      

  

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

  



  

    
      


1233

    		
    
      
# File 'sig/client.rbs', line 1233

def list_tags_for_resource: (


    		
  





    
      

  

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

  



  

    
      


1244

    		
    
      
# File 'sig/client.rbs', line 1244

def reset_deployments: (


    		
  





    
      

  

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

  



  

    
      


1257

    		
    
      
# File 'sig/client.rbs', line 1257

def start_bulk_deployment: (


    		
  





    
      

  

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

  



  

    
      


1269

    		
    
      
# File 'sig/client.rbs', line 1269

def stop_bulk_deployment: (


    		
  





    
      

  

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

  



  

    
      


1275

    		
    
      
# File 'sig/client.rbs', line 1275

def tag_resource: (


    		
  





    
      

  

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

  



  

    
      


1282

    		
    
      
# File 'sig/client.rbs', line 1282

def untag_resource: (


    		
  





    
      

  

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

  



  

    
      


1294

    		
    
      
# File 'sig/client.rbs', line 1294

def update_connectivity_info: (


    		
  





    
      

  

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

  



  

    
      


1311

    		
    
      
# File 'sig/client.rbs', line 1311

def update_connector_definition: (


    		
  





    
      

  

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

  



  

    
      


1321

    		
    
      
# File 'sig/client.rbs', line 1321

def update_core_definition: (


    		
  





    
      

  

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

  



  

    
      


1331

    		
    
      
# File 'sig/client.rbs', line 1331

def update_device_definition: (


    		
  





    
      

  

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

  



  

    
      


1341

    		
    
      
# File 'sig/client.rbs', line 1341

def update_function_definition: (


    		
  





    
      

  

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

  



  

    
      


1351

    		
    
      
# File 'sig/client.rbs', line 1351

def update_group: (


    		
  





    
      

  

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

  



  

    
      


1364

    		
    
      
# File 'sig/client.rbs', line 1364

def update_group_certificate_configuration: (


    		
  





    
      

  

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

  



  

    
      


1374

    		
    
      
# File 'sig/client.rbs', line 1374

def update_logger_definition: (


    		
  





    
      

  

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

  



  

    
      


1384

    		
    
      
# File 'sig/client.rbs', line 1384

def update_resource_definition: (


    		
  





    
      

  

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

  



  

    
      


1394

    		
    
      
# File 'sig/client.rbs', line 1394

def update_subscription_definition: (


    		
  





    
      

  

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

  



  

    
      


1404

    		
    
      
# File 'sig/client.rbs', line 1404

def update_thing_runtime_configuration: (


    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.



Deprecated. 



  





  



  

    
      


4258
4259
4260

    		
    
      
# File 'lib/aws-sdk-greengrass/client.rb', line 4258

def waiter_names
  []
end