Class: Aws::SsmSap::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SsmSap::Client
- 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
API Operations collapse
-
#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput
Removes permissions associated with the target database.
-
#deregister_application(params = {}) ⇒ Struct
Deregister an SAP application with AWS Systems Manager for SAP.
-
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Gets an application registered with AWS Systems Manager for SAP.
-
#get_component(params = {}) ⇒ Types::GetComponentOutput
Gets the component of an application registered with AWS Systems Manager for SAP.
-
#get_configuration_check_operation(params = {}) ⇒ Types::GetConfigurationCheckOperationOutput
Gets the details of a configuration check operation by specifying the operation ID.
-
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
-
#get_operation(params = {}) ⇒ Types::GetOperationOutput
Gets the details of an operation by specifying the operation ID.
-
#get_resource_permission(params = {}) ⇒ Types::GetResourcePermissionOutput
Gets permissions associated with the target database.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsOutput
Lists all the applications registered with AWS Systems Manager for SAP.
-
#list_components(params = {}) ⇒ Types::ListComponentsOutput
Lists all the components registered with AWS Systems Manager for SAP.
-
#list_configuration_check_definitions(params = {}) ⇒ Types::ListConfigurationCheckDefinitionsOutput
Lists all configuration check types supported by AWS Systems Manager for SAP.
-
#list_configuration_check_operations(params = {}) ⇒ Types::ListConfigurationCheckOperationsOutput
Lists the configuration check operations performed by AWS Systems Manager for SAP.
-
#list_databases(params = {}) ⇒ Types::ListDatabasesOutput
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
-
#list_operation_events(params = {}) ⇒ Types::ListOperationEventsOutput
Returns a list of operations events.
-
#list_operations(params = {}) ⇒ Types::ListOperationsOutput
Lists the operations performed by AWS Systems Manager for SAP.
-
#list_sub_check_results(params = {}) ⇒ Types::ListSubCheckResultsOutput
Lists the sub-check results of a specified configuration check operation.
-
#list_sub_check_rule_results(params = {}) ⇒ Types::ListSubCheckRuleResultsOutput
Lists the rules of a specified sub-check belonging to a configuration check operation.
-
#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.
-
#put_resource_permission(params = {}) ⇒ Types::PutResourcePermissionOutput
Adds permissions to the target database.
-
#register_application(params = {}) ⇒ Types::RegisterApplicationOutput
Register an SAP application with AWS Systems Manager for SAP.
-
#start_application(params = {}) ⇒ Types::StartApplicationOutput
Request is an operation which starts an application.
-
#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered application.
-
#start_configuration_checks(params = {}) ⇒ Types::StartConfigurationChecksOutput
Initiates configuration check operations against a specified application.
-
#stop_application(params = {}) ⇒ Types::StopApplicationOutput
Request is an operation to stop an application.
-
#tag_resource(params = {}) ⇒ Struct
Creates tag for a resource by specifying the ARN.
-
#untag_resource(params = {}) ⇒ Struct
Delete the tags for a resource.
-
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsOutput
Updates the settings of an application registered with AWS Systems Manager for SAP.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
473 474 475 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput
Removes permissions associated with the target database.
510 511 512 513 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 510 def (params = {}, = {}) req = build_request(:delete_resource_permission, params) req.send_request() 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.
534 535 536 537 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 534 def deregister_application(params = {}, = {}) req = build_request(:deregister_application, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
585 586 587 588 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 585 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentOutput
Gets the component of an application registered with AWS Systems Manager for SAP.
660 661 662 663 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 660 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_configuration_check_operation(params = {}) ⇒ Types::GetConfigurationCheckOperationOutput
Gets the details of a configuration check operation by specifying the operation ID.
702 703 704 705 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 702 def get_configuration_check_operation(params = {}, = {}) req = build_request(:get_configuration_check_operation, params) req.send_request() end |
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
761 762 763 764 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 761 def get_database(params = {}, = {}) req = build_request(:get_database, params) req.send_request() end |
#get_operation(params = {}) ⇒ Types::GetOperationOutput
Gets the details of an operation by specifying the operation ID.
800 801 802 803 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 800 def get_operation(params = {}, = {}) req = build_request(:get_operation, params) req.send_request() end |
#get_resource_permission(params = {}) ⇒ Types::GetResourcePermissionOutput
Gets permissions associated with the target database.
831 832 833 834 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 831 def (params = {}, = {}) req = build_request(:get_resource_permission, params) req.send_request() 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.
886 887 888 889 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 886 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() 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.
937 938 939 940 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 937 def list_components(params = {}, = {}) req = build_request(:list_components, params) req.send_request() end |
#list_configuration_check_definitions(params = {}) ⇒ Types::ListConfigurationCheckDefinitionsOutput
Lists all configuration check types supported by AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
981 982 983 984 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 981 def list_configuration_check_definitions(params = {}, = {}) req = build_request(:list_configuration_check_definitions, params) req.send_request() end |
#list_configuration_check_operations(params = {}) ⇒ Types::ListConfigurationCheckOperationsOutput
Lists the configuration check operations performed by AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1059 def list_configuration_check_operations(params = {}, = {}) req = build_request(:list_configuration_check_operations, params) req.send_request() 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.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1114 def list_databases(params = {}, = {}) req = build_request(:list_databases, params) req.send_request() 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.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1183 def list_operation_events(params = {}, = {}) req = build_request(:list_operation_events, params) req.send_request() 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.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1248 def list_operations(params = {}, = {}) req = build_request(:list_operations, params) req.send_request() end |
#list_sub_check_results(params = {}) ⇒ Types::ListSubCheckResultsOutput
Lists the sub-check results of a specified configuration check operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1296 def list_sub_check_results(params = {}, = {}) req = build_request(:list_sub_check_results, params) req.send_request() end |
#list_sub_check_rule_results(params = {}) ⇒ Types::ListSubCheckRuleResultsOutput
Lists the rules of a specified sub-check belonging to a configuration check operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1345 def list_sub_check_rule_results(params = {}, = {}) req = build_request(:list_sub_check_rule_results, params) req.send_request() 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.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1375 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_resource_permission(params = {}) ⇒ Types::PutResourcePermissionOutput
Adds permissions to the target database.
1408 1409 1410 1411 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1408 def (params = {}, = {}) req = build_request(:put_resource_permission, params) req.send_request() 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1509 def register_application(params = {}, = {}) req = build_request(:register_application, params) req.send_request() end |
#start_application(params = {}) ⇒ Types::StartApplicationOutput
Request is an operation which starts an application.
Parameter ApplicationId
is required.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1539 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered application.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1567 def start_application_refresh(params = {}, = {}) req = build_request(:start_application_refresh, params) req.send_request() end |
#start_configuration_checks(params = {}) ⇒ Types::StartConfigurationChecksOutput
Initiates configuration check operations against a specified application.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1614 def start_configuration_checks(params = {}, = {}) req = build_request(:start_configuration_checks, params) req.send_request() end |
#stop_application(params = {}) ⇒ Types::StopApplicationOutput
Request is an operation to stop an application.
Parameter ApplicationId
is required. Parameters
StopConnectedEntity
and IncludeEc2InstanceShutdown
are optional.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1658 def stop_application(params = {}, = {}) req = build_request(:stop_application, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates tag for a resource by specifying the ARN.
1686 1687 1688 1689 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1686 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Delete the tags for a resource.
1713 1714 1715 1716 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1713 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsOutput
Updates the settings of an application registered with AWS Systems Manager for SAP.
1777 1778 1779 1780 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1777 def update_application_settings(params = {}, = {}) req = build_request(:update_application_settings, params) req.send_request() end |