Class: Aws::SsmSap::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :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. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. 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)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

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

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :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) —

    A Bearer Token Provider. This can be an 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::SsmSap::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::SsmSap::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.



440
441
442
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 440

def initialize(*args)
  super
end

Instance Method Details

#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput

Removes permissions associated with the target database.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_permission({
  action_type: "RESTORE", # accepts RESTORE
  source_resource_arn: "Arn",
  resource_arn: "Arn", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_type (String) —

    Delete or restore the permissions on the target database.

  • :source_resource_arn (String) —

    The Amazon Resource Name (ARN) of the source resource.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



477
478
479
480
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 477

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

#deregister_application(params = {}) ⇒ Struct

Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.

Examples:

Request syntax with placeholder values


resp = client.deregister_application({
  application_id: "ApplicationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



501
502
503
504
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 501

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

#get_application(params = {}) ⇒ Types::GetApplicationOutput

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application_id: "ApplicationId",
  application_arn: "SsmSapArn",
  app_registry_arn: "AppRegistryArn",
})

Response structure


resp.application.id #=> String
resp.application.type #=> String, one of "HANA", "SAP_ABAP"
resp.application.arn #=> String
resp.application.app_registry_arn #=> String
resp.application.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "FAILED", "REGISTERING", "DELETING", "UNKNOWN"
resp.application.discovery_status #=> String, one of "SUCCESS", "REGISTRATION_FAILED", "REFRESH_FAILED", "REGISTERING", "DELETING"
resp.application.components #=> Array
resp.application.components[0] #=> String
resp.application.last_updated #=> Time
resp.application.status_message #=> String
resp.application.associated_application_arns #=> Array
resp.application.associated_application_arns[0] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (String) —

    The ID of the application.

  • :application_arn (String) —

    The Amazon Resource Name (ARN) of the application.

  • :app_registry_arn (String) —

    The Amazon Resource Name (ARN) of the application registry.

Returns:

See Also:



552
553
554
555
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 552

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

#get_component(params = {}) ⇒ Types::GetComponentOutput

Gets the component of an application registered with AWS Systems Manager for SAP.

Examples:

Request syntax with placeholder values


resp = client.get_component({
  application_id: "ApplicationId", # required
  component_id: "ComponentId", # required
})

Response structure


resp.component.component_id #=> String
resp.component.sid #=> String
resp.component.system_number #=> String
resp.component.parent_component #=> String
resp.component.child_components #=> Array
resp.component.child_components[0] #=> String
resp.component.application_id #=> String
resp.component.component_type #=> String, one of "HANA", "HANA_NODE", "ABAP", "ASCS", "DIALOG", "WEBDISP", "WD", "ERS"
resp.component.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "RUNNING", "RUNNING_WITH_ERROR", "UNDEFINED"
resp.component.sap_hostname #=> String
resp.component.sap_feature #=> String
resp.component.sap_kernel_version #=> String
resp.component.hdb_version #=> String
resp.component.resilience.hsr_tier #=> String
resp.component.resilience.hsr_replication_mode #=> String, one of "PRIMARY", "NONE", "SYNC", "SYNCMEM", "ASYNC"
resp.component.resilience.hsr_operation_mode #=> String, one of "PRIMARY", "LOGREPLAY", "DELTA_DATASHIPPING", "LOGREPLAY_READACCESS", "NONE"
resp.component.resilience.cluster_status #=> String, one of "ONLINE", "STANDBY", "MAINTENANCE", "OFFLINE", "NONE"
resp.component.resilience.enqueue_replication #=> Boolean
resp.component.associated_host.hostname #=> String
resp.component.associated_host.ec2_instance_id #=> String
resp.component.associated_host.ip_addresses #=> Array
resp.component.associated_host.ip_addresses[0].ip_address #=> String
resp.component.associated_host.ip_addresses[0].primary #=> Boolean
resp.component.associated_host.ip_addresses[0].allocation_type #=> String, one of "VPC_SUBNET", "ELASTIC_IP", "OVERLAY", "UNKNOWN"
resp.component.associated_host.os_version #=> String
resp.component.databases #=> Array
resp.component.databases[0] #=> String
resp.component.hosts #=> Array
resp.component.hosts[0].host_name #=> String
resp.component.hosts[0].host_ip #=> String
resp.component.hosts[0].ec2_instance_id #=> String
resp.component.hosts[0].instance_id #=> String
resp.component.hosts[0].host_role #=> String, one of "LEADER", "WORKER", "STANDBY", "UNKNOWN"
resp.component.hosts[0].os_version #=> String
resp.component.primary_host #=> String
resp.component.database_connection.database_connection_method #=> String, one of "DIRECT", "OVERLAY"
resp.component.database_connection.database_arn #=> String
resp.component.database_connection.connection_ip #=> String
resp.component.last_updated #=> Time
resp.component.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :component_id (required, String) —

    The ID of the component.

Returns:

See Also:



627
628
629
630
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 627

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

#get_database(params = {}) ⇒ Types::GetDatabaseOutput

Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

Examples:

Request syntax with placeholder values


resp = client.get_database({
  application_id: "ApplicationId",
  component_id: "ComponentId",
  database_id: "DatabaseId",
  database_arn: "SsmSapArn",
})

Response structure


resp.database.application_id #=> String
resp.database.component_id #=> String
resp.database.credentials #=> Array
resp.database.credentials[0].database_name #=> String
resp.database.credentials[0].credential_type #=> String, one of "ADMIN"
resp.database.credentials[0].secret_id #=> String
resp.database.database_id #=> String
resp.database.database_name #=> String
resp.database.database_type #=> String, one of "SYSTEM", "TENANT"
resp.database.arn #=> String
resp.database.status #=> String, one of "RUNNING", "STARTING", "STOPPED", "WARNING", "UNKNOWN", "ERROR"
resp.database.primary_host #=> String
resp.database.sql_port #=> Integer
resp.database.last_updated #=> Time
resp.database.connected_component_arns #=> Array
resp.database.connected_component_arns[0] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (String) —

    The ID of the application.

  • :component_id (String) —

    The ID of the component.

  • :database_id (String) —

    The ID of the database.

  • :database_arn (String) —

    The Amazon Resource Name (ARN) of the database.

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 686

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

#get_operation(params = {}) ⇒ Types::GetOperationOutput

Gets the details of an operation by specifying the operation ID.

Examples:

Request syntax with placeholder values


resp = client.get_operation({
  operation_id: "OperationId", # required
})

Response structure


resp.operation.id #=> String
resp.operation.type #=> String
resp.operation.status #=> String, one of "INPROGRESS", "SUCCESS", "ERROR"
resp.operation.status_message #=> String
resp.operation.properties #=> Hash
resp.operation.properties["String"] #=> String
resp.operation.resource_type #=> String
resp.operation.resource_id #=> String
resp.operation.resource_arn #=> String
resp.operation.start_time #=> Time
resp.operation.end_time #=> Time
resp.operation.last_updated_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :operation_id (required, String) —

    The ID of the operation.

Returns:

See Also:



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

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

#get_resource_permission(params = {}) ⇒ Types::GetResourcePermissionOutput

Gets permissions associated with the target database.

Examples:

Request syntax with placeholder values


resp = client.get_resource_permission({
  action_type: "RESTORE", # accepts RESTORE
  resource_arn: "Arn", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_type (String)
  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



756
757
758
759
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 756

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

#list_applications(params = {}) ⇒ Types::ListApplicationsOutput

Lists all the applications registered with AWS Systems Manager for SAP.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "FilterName", # required
      value: "FilterValue", # required
      operator: "Equals", # required, accepts Equals, GreaterThanOrEquals, LessThanOrEquals
    },
  ],
})

Response structure


resp.applications #=> Array
resp.applications[0].id #=> String
resp.applications[0].discovery_status #=> String, one of "SUCCESS", "REGISTRATION_FAILED", "REFRESH_FAILED", "REGISTERING", "DELETING"
resp.applications[0].type #=> String, one of "HANA", "SAP_ABAP"
resp.applications[0].arn #=> String
resp.applications[0].tags #=> Hash
resp.applications[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :filters (Array<Types::Filter>) —

    The filter of name, value, and operator.

Returns:

See Also:



811
812
813
814
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 811

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

#list_components(params = {}) ⇒ Types::ListComponentsOutput

Lists all the components registered with AWS Systems Manager for SAP.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_components({
  application_id: "ApplicationId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.components #=> Array
resp.components[0].application_id #=> String
resp.components[0].component_id #=> String
resp.components[0].component_type #=> String, one of "HANA", "HANA_NODE", "ABAP", "ASCS", "DIALOG", "WEBDISP", "WD", "ERS"
resp.components[0].tags #=> Hash
resp.components[0].tags["TagKey"] #=> String
resp.components[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (String) —

    The ID of the application.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Returns:

See Also:



862
863
864
865
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 862

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

#list_databases(params = {}) ⇒ Types::ListDatabasesOutput

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_databases({
  application_id: "ApplicationId",
  component_id: "ComponentId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.databases #=> Array
resp.databases[0].application_id #=> String
resp.databases[0].component_id #=> String
resp.databases[0].database_id #=> String
resp.databases[0].database_type #=> String, one of "SYSTEM", "TENANT"
resp.databases[0].arn #=> String
resp.databases[0].tags #=> Hash
resp.databases[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (String) —

    The ID of the application.

  • :component_id (String) —

    The ID of the component.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Returns:

See Also:



917
918
919
920
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 917

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

#list_operation_events(params = {}) ⇒ Types::ListOperationEventsOutput

Returns a list of operations events.

Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_operation_events({
  operation_id: "OperationId", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName", # required
      value: "FilterValue", # required
      operator: "Equals", # required, accepts Equals, GreaterThanOrEquals, LessThanOrEquals
    },
  ],
})

Response structure


resp.operation_events #=> Array
resp.operation_events[0].description #=> String
resp.operation_events[0].resource.resource_arn #=> String
resp.operation_events[0].resource.resource_type #=> String
resp.operation_events[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.operation_events[0].status_message #=> String
resp.operation_events[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :operation_id (required, String) —

    The ID of the operation.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

  • :next_token (String) —

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

  • :filters (Array<Types::Filter>) —

    Optionally specify filters to narrow the returned operation event items.

    Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.

Returns:

See Also:



986
987
988
989
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 986

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

#list_operations(params = {}) ⇒ Types::ListOperationsOutput

Lists the operations performed by AWS Systems Manager for SAP.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_operations({
  application_id: "ApplicationId", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName", # required
      value: "FilterValue", # required
      operator: "Equals", # required, accepts Equals, GreaterThanOrEquals, LessThanOrEquals
    },
  ],
})

Response structure


resp.operations #=> Array
resp.operations[0].id #=> String
resp.operations[0].type #=> String
resp.operations[0].status #=> String, one of "INPROGRESS", "SUCCESS", "ERROR"
resp.operations[0].status_message #=> String
resp.operations[0].properties #=> Hash
resp.operations[0].properties["String"] #=> String
resp.operations[0].resource_type #=> String
resp.operations[0].resource_id #=> String
resp.operations[0].resource_arn #=> String
resp.operations[0].start_time #=> Time
resp.operations[0].end_time #=> Time
resp.operations[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    The filters of an operation.

Returns:

See Also:



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

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

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

Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1081
1082
1083
1084
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1081

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

#put_resource_permission(params = {}) ⇒ Types::PutResourcePermissionOutput

Adds permissions to the target database.

Examples:

Request syntax with placeholder values


resp = client.put_resource_permission({
  action_type: "RESTORE", # required, accepts RESTORE
  source_resource_arn: "Arn", # required
  resource_arn: "Arn", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_type (required, String)
  • :source_resource_arn (required, String)
  • :resource_arn (required, String)

Returns:

See Also:



1114
1115
1116
1117
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1114

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

#register_application(params = {}) ⇒ Types::RegisterApplicationOutput

Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

Examples:

Request syntax with placeholder values


resp = client.register_application({
  application_id: "ApplicationId", # required
  application_type: "HANA", # required, accepts HANA, SAP_ABAP
  instances: ["InstanceId"], # required
  sap_instance_number: "SAPInstanceNumber",
  sid: "SID",
  tags: {
    "TagKey" => "TagValue",
  },
  credentials: [
    {
      database_name: "DatabaseName", # required
      credential_type: "ADMIN", # required, accepts ADMIN
      secret_id: "SecretId", # required
    },
  ],
  database_arn: "SsmSapArn",
})

Response structure


resp.application.id #=> String
resp.application.type #=> String, one of "HANA", "SAP_ABAP"
resp.application.arn #=> String
resp.application.app_registry_arn #=> String
resp.application.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "FAILED", "REGISTERING", "DELETING", "UNKNOWN"
resp.application.discovery_status #=> String, one of "SUCCESS", "REGISTRATION_FAILED", "REFRESH_FAILED", "REGISTERING", "DELETING"
resp.application.components #=> Array
resp.application.components[0] #=> String
resp.application.last_updated #=> Time
resp.application.status_message #=> String
resp.application.associated_application_arns #=> Array
resp.application.associated_application_arns[0] #=> String
resp.operation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :application_type (required, String) —

    The type of the application.

  • :instances (required, Array<String>) —

    The Amazon EC2 instances on which your SAP application is running.

  • :sap_instance_number (String) —

    The SAP instance number of the application.

  • :sid (String) —

    The System ID of the application.

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

    The tags to be attached to the SAP application.

  • :credentials (Array<Types::ApplicationCredential>) —

    The credentials of the SAP application.

  • :database_arn (String) —

    The Amazon Resource Name of the SAP HANA database.

Returns:

See Also:



1201
1202
1203
1204
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1201

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

#start_application(params = {}) ⇒ Types::StartApplicationOutput

Request is an operation which starts an application.

Parameter ApplicationId is required.

Examples:

Request syntax with placeholder values


resp = client.start_application({
  application_id: "ApplicationId", # required
})

Response structure


resp.operation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

Returns:

See Also:



1231
1232
1233
1234
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1231

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

#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput

Refreshes a registered application.

Examples:

Request syntax with placeholder values


resp = client.start_application_refresh({
  application_id: "ApplicationId", # required
})

Response structure


resp.operation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

Returns:

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1259

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

#stop_application(params = {}) ⇒ Types::StopApplicationOutput

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

Examples:

Request syntax with placeholder values


resp = client.stop_application({
  application_id: "ApplicationId", # required
  stop_connected_entity: "DBMS", # accepts DBMS
  include_ec2_instance_shutdown: false,
})

Response structure


resp.operation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :stop_connected_entity (String) —

    Specify the ConnectedEntityType. Accepted type is DBMS.

    If this parameter is included, the connected DBMS (Database Management System) will be stopped.

  • :include_ec2_instance_shutdown (Boolean) —

    Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

Returns:

See Also:



1303
1304
1305
1306
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1303

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

#tag_resource(params = {}) ⇒ Struct

Creates tag for a resource by specifying the ARN.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    The tags on a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1331
1332
1333
1334
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1331

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

#untag_resource(params = {}) ⇒ Struct

Delete the tags for a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1358
1359
1360
1361
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1358

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

#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsOutput

Updates the settings of an application registered with AWS Systems Manager for SAP.

Examples:

Request syntax with placeholder values


resp = client.update_application_settings({
  application_id: "ApplicationId", # required
  credentials_to_add_or_update: [
    {
      database_name: "DatabaseName", # required
      credential_type: "ADMIN", # required, accepts ADMIN
      secret_id: "SecretId", # required
    },
  ],
  credentials_to_remove: [
    {
      database_name: "DatabaseName", # required
      credential_type: "ADMIN", # required, accepts ADMIN
      secret_id: "SecretId", # required
    },
  ],
  backint: {
    backint_mode: "AWSBackup", # required, accepts AWSBackup
    ensure_no_backup_in_process: false, # required
  },
  database_arn: "SsmSapArn",
})

Response structure


resp.message #=> String
resp.operation_ids #=> Array
resp.operation_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :credentials_to_add_or_update (Array<Types::ApplicationCredential>) —

    The credentials to be added or updated.

  • :credentials_to_remove (Array<Types::ApplicationCredential>) —

    The credentials to be removed.

  • :backint (Types::BackintConfig) —

    Installation of AWS Backint Agent for SAP HANA.

  • :database_arn (String) —

    The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

Returns:

See Also:



1422
1423
1424
1425
 
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1422

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