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_export_task(params = {}) ⇒ Types::CreateDataSetExportTaskResponse
Starts a data set export task for a specific application.
-
#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_export_task(params = {}) ⇒ Types::GetDataSetExportTaskResponse
Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
-
#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 a JCL file to restart a batch job.
-
#list_data_set_export_history(params = {}) ⇒ Types::ListDataSetExportHistoryResponse
Lists the data set exports for the specified application.
-
#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.
466 467 468 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#cancel_batch_job_execution(params = {}) ⇒ Struct
Cancels the running of a specific batch job execution.
499 500 501 502 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 499 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.
575 576 577 578 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 575 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_data_set_export_task(params = {}) ⇒ Types::CreateDataSetExportTaskResponse
Starts a data set export task for a specific application.
634 635 636 637 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 634 def create_data_set_export_task(params = {}, = {}) req = build_request(:create_data_set_export_task, params) req.send_request() end |
#create_data_set_import_task(params = {}) ⇒ Types::CreateDataSetImportTaskResponse
Starts a data set import task for a specific application.
730 731 732 733 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 730 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.
780 781 782 783 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 780 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.
898 899 900 901 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 898 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.
921 922 923 924 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 921 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.
953 954 955 956 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 953 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.
977 978 979 980 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 977 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1054 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.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1098 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.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1173 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.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1239 def get_data_set_details(params = {}, = {}) req = build_request(:get_data_set_details, params) req.send_request() end |
#get_data_set_export_task(params = {}) ⇒ Types::GetDataSetExportTaskResponse
Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1284 def get_data_set_export_task(params = {}, = {}) req = build_request(:get_data_set_export_task, 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.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1325 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.
1370 1371 1372 1373 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1370 def get_deployment(params = {}, = {}) req = build_request(:get_deployment, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Describes a specific runtime environment.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1451 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.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1471 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.
1517 1518 1519 1520 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1517 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.
1579 1580 1581 1582 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1579 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.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1631 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.
1716 1717 1718 1719 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1716 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 a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
1764 1765 1766 1767 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1764 def list_batch_job_restart_points(params = {}, = {}) req = build_request(:list_batch_job_restart_points, params) req.send_request() end |
#list_data_set_export_history(params = {}) ⇒ Types::ListDataSetExportHistoryResponse
Lists the data set exports for the specified application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1814 1815 1816 1817 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1814 def list_data_set_export_history(params = {}, = {}) req = build_request(:list_data_set_export_history, 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.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1864 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.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1932 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.
1984 1985 1986 1987 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1984 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.
2028 2029 2030 2031 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2028 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.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2083 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.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2112 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.
2134 2135 2136 2137 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2134 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.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2213 def start_batch_job(params = {}, = {}) req = build_request(:start_batch_job, params) req.send_request() end |
#stop_application(params = {}) ⇒ Struct
Stops a running application.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2242 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.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2270 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2296 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.
2340 2341 2342 2343 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2340 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.
2415 2416 2417 2418 |
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2415 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |