Class: Aws::MainframeModernization::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MainframeModernization::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb
Overview
An API client for MainframeModernization. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MainframeModernization::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
-
#cancel_batch_job_execution(params = {}) ⇒ Struct
Cancels the running of a specific batch job execution.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application with given parameters.
-
#create_data_set_import_task(params = {}) ⇒ Types::CreateDataSetImportTaskResponse
Starts a data set import task for a specific application.
-
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse
Creates and starts a deployment to deploy an application into a runtime environment.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
Creates a runtime environment for a given runtime engine.
-
#delete_application(params = {}) ⇒ Struct
Deletes a specific application.
-
#delete_application_from_environment(params = {}) ⇒ Struct
Deletes a specific application from the specific runtime environment where it was previously deployed.
-
#delete_environment(params = {}) ⇒ Struct
Deletes a specific runtime environment.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Describes the details of a specific application.
-
#get_application_version(params = {}) ⇒ Types::GetApplicationVersionResponse
Returns details about a specific version of a specific application.
-
#get_batch_job_execution(params = {}) ⇒ Types::GetBatchJobExecutionResponse
Gets the details of a specific batch job execution for a specific application.
-
#get_data_set_details(params = {}) ⇒ Types::GetDataSetDetailsResponse
Gets the details of a specific data set.
-
#get_data_set_import_task(params = {}) ⇒ Types::GetDataSetImportTaskResponse
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
-
#get_deployment(params = {}) ⇒ Types::GetDeploymentResponse
Gets details of a specific deployment with a given deployment identifier.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Describes a specific runtime environment.
-
#get_signed_bluinsights_url(params = {}) ⇒ Types::GetSignedBluinsightsUrlResponse
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
-
#list_application_versions(params = {}) ⇒ Types::ListApplicationVersionsResponse
Returns a list of the application versions for a specific application.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists the applications associated with a specific Amazon Web Services account.
-
#list_batch_job_definitions(params = {}) ⇒ Types::ListBatchJobDefinitionsResponse
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.
-
#list_batch_job_executions(params = {}) ⇒ Types::ListBatchJobExecutionsResponse
Lists historical, current, and scheduled batch job executions for a specific application.
-
#list_batch_job_restart_points(params = {}) ⇒ Types::ListBatchJobRestartPointsResponse
Lists all the job steps for JCL files to restart a batch job.
-
#list_data_set_import_history(params = {}) ⇒ Types::ListDataSetImportHistoryResponse
Lists the data set imports for the specified application.
-
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
Lists the data sets imported for a specific application.
-
#list_deployments(params = {}) ⇒ Types::ListDeploymentsResponse
Returns a list of all deployments of a specific application.
-
#list_engine_versions(params = {}) ⇒ Types::ListEngineVersionsResponse
Lists the available engine versions.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists the runtime environments.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#start_application(params = {}) ⇒ Struct
Starts an application that is currently stopped.
-
#start_batch_job(params = {}) ⇒ Types::StartBatchJobResponse
Starts a batch job and returns the unique identifier of this execution of the batch job.
-
#stop_application(params = {}) ⇒ Struct
Stops a running application.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an application and creates a new version.
-
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentResponse
Updates the configuration details for a specific runtime environment.
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.
444 445 446 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#cancel_batch_job_execution(params = {}) ⇒ Struct
Cancels the running of a specific batch job execution.
471 472 473 474 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 471 def cancel_batch_job_execution(params = {}, = {}) req = build_request(:cancel_batch_job_execution, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
549 550 551 552 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 549 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_data_set_import_task(params = {}) ⇒ Types::CreateDataSetImportTaskResponse
Starts a data set import task for a specific application.
645 646 647 648 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 645 def create_data_set_import_task(params = {}, = {}) req = build_request(:create_data_set_import_task, params) req.send_request() end |
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse
Creates and starts a deployment to deploy an application into a runtime environment.
695 696 697 698 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 695 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
Creates a runtime environment for a given runtime engine.
809 810 811 812 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 809 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes a specific application. You cannot delete a running application.
832 833 834 835 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 832 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_application_from_environment(params = {}) ⇒ Struct
Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
864 865 866 867 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 864 def delete_application_from_environment(params = {}, = {}) req = build_request(:delete_application_from_environment, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Struct
Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
888 889 890 891 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 888 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Describes the details of a specific application.
965 966 967 968 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 965 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_application_version(params = {}) ⇒ Types::GetApplicationVersionResponse
Returns details about a specific version of a specific application.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1009 def get_application_version(params = {}, = {}) req = build_request(:get_application_version, params) req.send_request() end |
#get_batch_job_execution(params = {}) ⇒ Types::GetBatchJobExecutionResponse
Gets the details of a specific batch job execution for a specific application.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1080 def get_batch_job_execution(params = {}, = {}) req = build_request(:get_batch_job_execution, params) req.send_request() end |
#get_data_set_details(params = {}) ⇒ Types::GetDataSetDetailsResponse
Gets the details of a specific data set.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1146 def get_data_set_details(params = {}, = {}) req = build_request(:get_data_set_details, params) req.send_request() end |
#get_data_set_import_task(params = {}) ⇒ Types::GetDataSetImportTaskResponse
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1187 def get_data_set_import_task(params = {}, = {}) req = build_request(:get_data_set_import_task, params) req.send_request() end |
#get_deployment(params = {}) ⇒ Types::GetDeploymentResponse
Gets details of a specific deployment with a given deployment identifier.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1232 def get_deployment(params = {}, = {}) req = build_request(:get_deployment, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Describes a specific runtime environment.
1311 1312 1313 1314 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1311 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#get_signed_bluinsights_url(params = {}) ⇒ Types::GetSignedBluinsightsUrlResponse
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1331 def get_signed_bluinsights_url(params = {}, = {}) req = build_request(:get_signed_bluinsights_url, params) req.send_request() end |
#list_application_versions(params = {}) ⇒ Types::ListApplicationVersionsResponse
Returns a list of the application versions for a specific application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1377 def list_application_versions(params = {}, = {}) req = build_request(:list_application_versions, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1439 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_batch_job_definitions(params = {}) ⇒ Types::ListBatchJobDefinitionsResponse
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1491 def list_batch_job_definitions(params = {}, = {}) req = build_request(:list_batch_job_definitions, params) req.send_request() end |
#list_batch_job_executions(params = {}) ⇒ Types::ListBatchJobExecutionsResponse
Lists historical, current, and scheduled batch job executions for a specific application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1574 def list_batch_job_executions(params = {}, = {}) req = build_request(:list_batch_job_executions, params) req.send_request() end |
#list_batch_job_restart_points(params = {}) ⇒ Types::ListBatchJobRestartPointsResponse
Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
1613 1614 1615 1616 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1613 def list_batch_job_restart_points(params = {}, = {}) req = build_request(:list_batch_job_restart_points, params) req.send_request() end |
#list_data_set_import_history(params = {}) ⇒ Types::ListDataSetImportHistoryResponse
Lists the data set imports for the specified application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1663 def list_data_set_import_history(params = {}, = {}) req = build_request(:list_data_set_import_history, params) req.send_request() end |
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1731 1732 1733 1734 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1731 def list_data_sets(params = {}, = {}) req = build_request(:list_data_sets, params) req.send_request() end |
#list_deployments(params = {}) ⇒ Types::ListDeploymentsResponse
Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1783 def list_deployments(params = {}, = {}) req = build_request(:list_deployments, params) req.send_request() end |
#list_engine_versions(params = {}) ⇒ Types::ListEngineVersionsResponse
Lists the available engine versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1827 1828 1829 1830 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1827 def list_engine_versions(params = {}, = {}) req = build_request(:list_engine_versions, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists the runtime environments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1881 1882 1883 1884 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1881 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
1910 1911 1912 1913 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1910 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_application(params = {}) ⇒ Struct
Starts an application that is currently stopped.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1932 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#start_batch_job(params = {}) ⇒ Types::StartBatchJobResponse
Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2003 def start_batch_job(params = {}, = {}) req = build_request(:start_batch_job, params) req.send_request() end |
#stop_application(params = {}) ⇒ Struct
Stops a running application.
2032 2033 2034 2035 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2032 def stop_application(params = {}, = {}) req = build_request(:stop_application, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
2060 2061 2062 2063 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2060 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
2086 2087 2088 2089 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2086 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an application and creates a new version.
2130 2131 2132 2133 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2130 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentResponse
Updates the configuration details for a specific runtime environment.
2205 2206 2207 2208 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2205 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |