Class: Aws::MainframeModernization::Client

Inherits:
Seahorse::Client::Base show all
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

#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::MainframeModernization::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MainframeModernization::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-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 440

def initialize(*args)
  super
end

Instance Method Details

#cancel_batch_job_execution(params = {}) ⇒ Struct

Cancels the running of a specific batch job execution.

Examples:

Request syntax with placeholder values


resp = client.cancel_batch_job_execution({
  application_id: "Identifier", # required
  execution_id: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :execution_id (required, String) —

    The unique identifier of the batch job execution.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



467
468
469
470
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 467

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

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates a new application with given parameters. Requires an existing runtime environment and application definition file.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  client_token: "String",
  definition: { # required
    content: "StringFree65000",
    s3_location: "String2000",
  },
  description: "EntityDescription",
  engine_type: "microfocus", # required, accepts microfocus, bluage
  kms_key_id: "String",
  name: "EntityName", # required
  role_arn: "Arn",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.application_arn #=> String
resp.application_id #=> String
resp.application_version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :definition (required, Types::Definition) —

    The application definition for this application. You can specify either inline JSON or an S3 bucket location.

  • :description (String) —

    The description of the application.

  • :engine_type (required, String) —

    The type of the target platform for this application.

  • :kms_key_id (String) —

    The identifier of a customer managed key.

  • :name (required, String) —

    The unique identifier of the application.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.

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

    A list of tags to apply to the application.

Returns:

See Also:



545
546
547
548
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 545

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

#create_data_set_import_task(params = {}) ⇒ Types::CreateDataSetImportTaskResponse

Starts a data set import task for a specific application.

Examples:

Request syntax with placeholder values


resp = client.create_data_set_import_task({
  application_id: "Identifier", # required
  client_token: "String",
  import_config: { # required
    data_sets: [
      {
        data_set: { # required
          dataset_name: "String", # required
          dataset_org: { # required
            gdg: {
              limit: 1,
              roll_disposition: "String",
            },
            po: {
              encoding: "String",
              format: "String", # required
              member_file_extensions: ["String20"], # required
            },
            ps: {
              encoding: "String",
              format: "String", # required
            },
            vsam: {
              alternate_keys: [
                {
                  allow_duplicates: false,
                  length: 1, # required
                  name: "String",
                  offset: 1, # required
                },
              ],
              compressed: false,
              encoding: "String",
              format: "String", # required
              primary_key: {
                length: 1, # required
                name: "String",
                offset: 1, # required
              },
            },
          },
          record_length: { # required
            max: 1, # required
            min: 1, # required
          },
          relative_path: "String",
          storage_type: "String",
        },
        external_location: { # required
          s3_location: "String2000",
        },
      },
    ],
    s3_location: "String2000",
  },
})

Response structure


resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application for which you want to import data sets.

  • :client_token (String) —

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :import_config (required, Types::DataSetImportConfig) —

    The data set import task configuration.

Returns:

See Also:



641
642
643
644
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 641

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

#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse

Creates and starts a deployment to deploy an application into a runtime environment.

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  application_id: "Identifier", # required
  application_version: 1, # required
  client_token: "String",
  environment_id: "Identifier", # required
})

Response structure


resp.deployment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application identifier.

  • :application_version (required, Integer) —

    The version of the application to deploy.

  • :client_token (String) —

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :environment_id (required, String) —

    The identifier of the runtime environment where you want to deploy this application.

Returns:

See Also:



691
692
693
694
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 691

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

#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse

Creates a runtime environment for a given runtime engine.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  client_token: "String",
  description: "EntityDescription",
  engine_type: "microfocus", # required, accepts microfocus, bluage
  engine_version: "EngineVersion",
  high_availability_config: {
    desired_capacity: 1, # required
  },
  instance_type: "String20", # required
  kms_key_id: "String",
  name: "EntityName", # required
  preferred_maintenance_window: "String50",
  publicly_accessible: false,
  security_group_ids: ["String50"],
  storage_configurations: [
    {
      efs: {
        file_system_id: "String200", # required
        mount_point: "String200", # required
      },
      fsx: {
        file_system_id: "String200", # required
        mount_point: "String200", # required
      },
    },
  ],
  subnet_ids: ["String50"],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.environment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description of the runtime environment.

  • :engine_type (required, String) —

    The engine type for the runtime environment.

  • :engine_version (String) —

    The version of the engine type for the runtime environment.

  • :high_availability_config (Types::HighAvailabilityConfig) —

    The details of a high availability configuration for this runtime environment.

  • :instance_type (required, String) —

    The type of instance for the runtime environment.

  • :kms_key_id (String) —

    The identifier of a customer managed key.

  • :name (required, String) —

    The name of the runtime environment. Must be unique within the account.

  • :preferred_maintenance_window (String) —

    Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

    If you do not provide a value, a random system-generated value will be assigned.

  • :publicly_accessible (Boolean) —

    Specifies whether the runtime environment is publicly accessible.

  • :security_group_ids (Array<String>) —

    The list of security groups for the VPC associated with this runtime environment.

  • :storage_configurations (Array<Types::StorageConfiguration>) —

    Optional. The storage configurations for this runtime environment.

  • :subnet_ids (Array<String>) —

    The list of subnets associated with the VPC for this runtime environment.

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

    The tags for the runtime environment.

Returns:

See Also:



805
806
807
808
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 805

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

#delete_application(params = {}) ⇒ Struct

Deletes a specific application. You cannot delete a running application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application_id: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 828

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_application_from_environment({
  application_id: "Identifier", # required
  environment_id: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application you want to delete.

  • :environment_id (required, String) —

    The unique identifier of the runtime environment where the application was previously deployed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 860

def delete_application_from_environment(params = {}, options = {})
  req = build_request(:delete_application_from_environment, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  environment_id: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    The unique identifier of the runtime environment you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



884
885
886
887
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 884

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

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

Describes the details of a specific application.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application_id: "Identifier", # required
})

Response structure


resp.application_arn #=> String
resp.application_id #=> String
resp.creation_time #=> Time
resp.deployed_version.application_version #=> Integer
resp.deployed_version.status #=> String, one of "Deploying", "Succeeded", "Failed", "Updating Deployment"
resp.deployed_version.status_reason #=> String
resp.description #=> String
resp.engine_type #=> String, one of "microfocus", "bluage"
resp.environment_id #=> String
resp.kms_key_id #=> String
resp.last_start_time #=> Time
resp.latest_version.application_version #=> Integer
resp.latest_version.creation_time #=> Time
resp.latest_version.status #=> String, one of "Creating", "Available", "Failed"
resp.latest_version.status_reason #=> String
resp.listener_arns #=> Array
resp.listener_arns[0] #=> String
resp.listener_ports #=> Array
resp.listener_ports[0] #=> Integer
resp.load_balancer_dns_name #=> String
resp.log_groups #=> Array
resp.log_groups[0].log_group_name #=> String
resp.log_groups[0].log_type #=> String
resp.name #=> String
resp.role_arn #=> String
resp.status #=> String, one of "Creating", "Created", "Available", "Ready", "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting", "Deleting From Environment"
resp.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.target_group_arns #=> Array
resp.target_group_arns[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The identifier of the application.

Returns:

See Also:



961
962
963
964
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 961

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

#get_application_version(params = {}) ⇒ Types::GetApplicationVersionResponse

Returns details about a specific version of a specific application.

Examples:

Request syntax with placeholder values


resp = client.get_application_version({
  application_id: "Identifier", # required
  application_version: 1, # required
})

Response structure


resp.application_version #=> Integer
resp.creation_time #=> Time
resp.definition_content #=> String
resp.description #=> String
resp.name #=> String
resp.status #=> String, one of "Creating", "Available", "Failed"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :application_version (required, Integer) —

    The specific version of the application.

Returns:

See Also:



1005
1006
1007
1008
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1005

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

#get_batch_job_execution(params = {}) ⇒ Types::GetBatchJobExecutionResponse

Gets the details of a specific batch job execution for a specific application.

Examples:

Request syntax with placeholder values


resp = client.get_batch_job_execution({
  application_id: "Identifier", # required
  execution_id: "Identifier", # required
})

Response structure


resp.application_id #=> String
resp.batch_job_identifier.file_batch_job_identifier.file_name #=> String
resp.batch_job_identifier.file_batch_job_identifier.folder_path #=> String
resp.batch_job_identifier.restart_batch_job_identifier.execution_id #=> String
resp.batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.from_proc_step #=> String
resp.batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.from_step #=> String
resp.batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.to_proc_step #=> String
resp.batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.to_step #=> String
resp.batch_job_identifier.s3_batch_job_identifier.bucket #=> String
resp.batch_job_identifier.s3_batch_job_identifier.identifier.file_name #=> String
resp.batch_job_identifier.s3_batch_job_identifier.identifier.script_name #=> String
resp.batch_job_identifier.s3_batch_job_identifier.key_prefix #=> String
resp.batch_job_identifier.script_batch_job_identifier.script_name #=> String
resp.end_time #=> Time
resp.execution_id #=> String
resp.job_id #=> String
resp.job_name #=> String
resp.job_step_restart_marker.from_proc_step #=> String
resp.job_step_restart_marker.from_step #=> String
resp.job_step_restart_marker.to_proc_step #=> String
resp.job_step_restart_marker.to_step #=> String
resp.job_type #=> String, one of "VSE", "JES2", "JES3"
resp.job_user #=> String
resp.return_code #=> String
resp.start_time #=> Time
resp.status #=> String, one of "Submitting", "Holding", "Dispatching", "Running", "Cancelling", "Cancelled", "Succeeded", "Failed", "Purged", "Succeeded With Warning"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The identifier of the application.

  • :execution_id (required, String) —

    The unique identifier of the batch job execution.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1076

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

#get_data_set_details(params = {}) ⇒ Types::GetDataSetDetailsResponse

Gets the details of a specific data set.

Examples:

Request syntax with placeholder values


resp = client.get_data_set_details({
  application_id: "Identifier", # required
  data_set_name: "String200", # required
})

Response structure


resp.blocksize #=> Integer
resp.creation_time #=> Time
resp.data_set_name #=> String
resp.data_set_org.gdg.limit #=> Integer
resp.data_set_org.gdg.roll_disposition #=> String
resp.data_set_org.po.encoding #=> String
resp.data_set_org.po.format #=> String
resp.data_set_org.ps.encoding #=> String
resp.data_set_org.ps.format #=> String
resp.data_set_org.vsam.alternate_keys #=> Array
resp.data_set_org.vsam.alternate_keys[0].allow_duplicates #=> Boolean
resp.data_set_org.vsam.alternate_keys[0].length #=> Integer
resp.data_set_org.vsam.alternate_keys[0].name #=> String
resp.data_set_org.vsam.alternate_keys[0].offset #=> Integer
resp.data_set_org.vsam.cache_at_startup #=> Boolean
resp.data_set_org.vsam.compressed #=> Boolean
resp.data_set_org.vsam.encoding #=> String
resp.data_set_org.vsam.primary_key.length #=> Integer
resp.data_set_org.vsam.primary_key.name #=> String
resp.data_set_org.vsam.primary_key.offset #=> Integer
resp.data_set_org.vsam.record_format #=> String
resp.file_size #=> Integer
resp.last_referenced_time #=> Time
resp.last_updated_time #=> Time
resp.location #=> String
resp.record_length #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application that this data set is associated with.

  • :data_set_name (required, String) —

    The name of the data set.

Returns:

See Also:



1142
1143
1144
1145
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1142

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

#get_data_set_import_task(params = {}) ⇒ Types::GetDataSetImportTaskResponse

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

Examples:

Request syntax with placeholder values


resp = client.get_data_set_import_task({
  application_id: "Identifier", # required
  task_id: "Identifier", # required
})

Response structure


resp.status #=> String, one of "Creating", "Running", "Completed", "Failed"
resp.summary.failed #=> Integer
resp.summary.in_progress #=> Integer
resp.summary.pending #=> Integer
resp.summary.succeeded #=> Integer
resp.summary.total #=> Integer
resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application identifier.

  • :task_id (required, String) —

    The task identifier returned by the CreateDataSetImportTask operation.

Returns:

See Also:



1183
1184
1185
1186
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1183

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

#get_deployment(params = {}) ⇒ Types::GetDeploymentResponse

Gets details of a specific deployment with a given deployment identifier.

Examples:

Request syntax with placeholder values


resp = client.get_deployment({
  application_id: "Identifier", # required
  deployment_id: "Identifier", # required
})

Response structure


resp.application_id #=> String
resp.application_version #=> Integer
resp.creation_time #=> Time
resp.deployment_id #=> String
resp.environment_id #=> String
resp.status #=> String, one of "Deploying", "Succeeded", "Failed", "Updating Deployment"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :deployment_id (required, String) —

    The unique identifier for the deployment.

Returns:

See Also:



1228
1229
1230
1231
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1228

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

#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse

Describes a specific runtime environment.

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  environment_id: "Identifier", # required
})

Response structure


resp.actual_capacity #=> Integer
resp.creation_time #=> Time
resp.description #=> String
resp.engine_type #=> String, one of "microfocus", "bluage"
resp.engine_version #=> String
resp.environment_arn #=> String
resp.environment_id #=> String
resp.high_availability_config.desired_capacity #=> Integer
resp.instance_type #=> String
resp.kms_key_id #=> String
resp.load_balancer_arn #=> String
resp.name #=> String
resp.pending_maintenance.engine_version #=> String
resp.pending_maintenance.schedule.end_time #=> Time
resp.pending_maintenance.schedule.start_time #=> Time
resp.preferred_maintenance_window #=> String
resp.publicly_accessible #=> Boolean
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.status #=> String, one of "Creating", "Available", "Updating", "Deleting", "Failed"
resp.status_reason #=> String
resp.storage_configurations #=> Array
resp.storage_configurations[0].efs.file_system_id #=> String
resp.storage_configurations[0].efs.mount_point #=> String
resp.storage_configurations[0].fsx.file_system_id #=> String
resp.storage_configurations[0].fsx.mount_point #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    The unique identifier of the runtime environment.

Returns:

See Also:



1307
1308
1309
1310
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1307

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

#get_signed_bluinsights_url(params = {}) ⇒ Types::GetSignedBluinsightsUrlResponse

Gets a single sign-on URL that can be used to connect to AWS Blu Insights.

Examples:

Response structure


resp.signed_bi_url #=> String

Parameters:

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

    ({})

Returns:

See Also:



1327
1328
1329
1330
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1327

def get_signed_bluinsights_url(params = {}, options = {})
  req = build_request(:get_signed_bluinsights_url, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_application_versions({
  application_id: "Identifier", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.application_versions #=> Array
resp.application_versions[0].application_version #=> Integer
resp.application_versions[0].creation_time #=> Time
resp.application_versions[0].status #=> String, one of "Creating", "Available", "Failed"
resp.application_versions[0].status_reason #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :max_results (Integer) —

    The maximum number of application versions to return.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Returns:

See Also:



1373
1374
1375
1376
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1373

def list_application_versions(params = {}, options = {})
  req = build_request(:list_application_versions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  environment_id: "Identifier",
  max_results: 1,
  names: ["EntityName"],
  next_token: "NextToken",
})

Response structure


resp.applications #=> Array
resp.applications[0].application_arn #=> String
resp.applications[0].application_id #=> String
resp.applications[0].application_version #=> Integer
resp.applications[0].creation_time #=> Time
resp.applications[0].deployment_status #=> String, one of "Deploying", "Deployed"
resp.applications[0].description #=> String
resp.applications[0].engine_type #=> String, one of "microfocus", "bluage"
resp.applications[0].environment_id #=> String
resp.applications[0].last_start_time #=> Time
resp.applications[0].name #=> String
resp.applications[0].role_arn #=> String
resp.applications[0].status #=> String, one of "Creating", "Created", "Available", "Ready", "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting", "Deleting From Environment"
resp.applications[0].version_status #=> String, one of "Creating", "Available", "Failed"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_id (String) —

    The unique identifier of the runtime environment where the applications are deployed.

  • :max_results (Integer) —

    The maximum number of applications to return.

  • :names (Array<String>) —

    The names of the applications.

  • :next_token (String) —

    A pagination token to control the number of applications displayed in the list.

Returns:

See Also:



1435
1436
1437
1438
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1435

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_batch_job_definitions({
  application_id: "Identifier", # required
  max_results: 1,
  next_token: "NextToken",
  prefix: "String",
})

Response structure


resp.batch_job_definitions #=> Array
resp.batch_job_definitions[0].file_batch_job_definition.file_name #=> String
resp.batch_job_definitions[0].file_batch_job_definition.folder_path #=> String
resp.batch_job_definitions[0].script_batch_job_definition.script_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The identifier of the application.

  • :max_results (Integer) —

    The maximum number of batch job definitions to return.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

  • :prefix (String) —

    If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

Returns:

See Also:



1487
1488
1489
1490
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1487

def list_batch_job_definitions(params = {}, options = {})
  req = build_request(:list_batch_job_definitions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_batch_job_executions({
  application_id: "Identifier", # required
  execution_ids: ["Identifier"],
  job_name: "String100",
  max_results: 1,
  next_token: "NextToken",
  started_after: Time.now,
  started_before: Time.now,
  status: "Submitting", # accepts Submitting, Holding, Dispatching, Running, Cancelling, Cancelled, Succeeded, Failed, Purged, Succeeded With Warning
})

Response structure


resp.batch_job_executions #=> Array
resp.batch_job_executions[0].application_id #=> String
resp.batch_job_executions[0].batch_job_identifier.file_batch_job_identifier.file_name #=> String
resp.batch_job_executions[0].batch_job_identifier.file_batch_job_identifier.folder_path #=> String
resp.batch_job_executions[0].batch_job_identifier.restart_batch_job_identifier.execution_id #=> String
resp.batch_job_executions[0].batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.from_proc_step #=> String
resp.batch_job_executions[0].batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.from_step #=> String
resp.batch_job_executions[0].batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.to_proc_step #=> String
resp.batch_job_executions[0].batch_job_identifier.restart_batch_job_identifier.job_step_restart_marker.to_step #=> String
resp.batch_job_executions[0].batch_job_identifier.s3_batch_job_identifier.bucket #=> String
resp.batch_job_executions[0].batch_job_identifier.s3_batch_job_identifier.identifier.file_name #=> String
resp.batch_job_executions[0].batch_job_identifier.s3_batch_job_identifier.identifier.script_name #=> String
resp.batch_job_executions[0].batch_job_identifier.s3_batch_job_identifier.key_prefix #=> String
resp.batch_job_executions[0].batch_job_identifier.script_batch_job_identifier.script_name #=> String
resp.batch_job_executions[0].end_time #=> Time
resp.batch_job_executions[0].execution_id #=> String
resp.batch_job_executions[0].job_id #=> String
resp.batch_job_executions[0].job_name #=> String
resp.batch_job_executions[0].job_type #=> String, one of "VSE", "JES2", "JES3"
resp.batch_job_executions[0].return_code #=> String
resp.batch_job_executions[0].start_time #=> Time
resp.batch_job_executions[0].status #=> String, one of "Submitting", "Holding", "Dispatching", "Running", "Cancelling", "Cancelled", "Succeeded", "Failed", "Purged", "Succeeded With Warning"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :execution_ids (Array<String>) —

    The unique identifier of each batch job execution.

  • :job_name (String) —

    The name of each batch job execution.

  • :max_results (Integer) —

    The maximum number of batch job executions to return.

  • :next_token (String) —

    A pagination token to control the number of batch job executions displayed in the list.

  • :started_after (Time, DateTime, Date, Integer, String) —

    The time after which the batch job executions started.

  • :started_before (Time, DateTime, Date, Integer, String) —

    The time before the batch job executions started.

  • :status (String) —

    The status of the batch job executions.

Returns:

See Also:



1570
1571
1572
1573
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1570

def list_batch_job_executions(params = {}, options = {})
  req = build_request(:list_batch_job_executions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_batch_job_restart_points({
  application_id: "Identifier", # required
  execution_id: "Identifier", # required
})

Response structure


resp.batch_job_steps #=> Array
resp.batch_job_steps[0].proc_step_name #=> String
resp.batch_job_steps[0].proc_step_number #=> Integer
resp.batch_job_steps[0].step_cond_code #=> String
resp.batch_job_steps[0].step_name #=> String
resp.batch_job_steps[0].step_number #=> Integer
resp.batch_job_steps[0].step_restartable #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :execution_id (required, String) —

    The unique identifier of each batch job execution.

Returns:

See Also:



1609
1610
1611
1612
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1609

def list_batch_job_restart_points(params = {}, options = {})
  req = build_request(:list_batch_job_restart_points, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_data_set_import_history({
  application_id: "Identifier", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.data_set_import_tasks #=> Array
resp.data_set_import_tasks[0].status #=> String, one of "Creating", "Running", "Completed", "Failed"
resp.data_set_import_tasks[0].status_reason #=> String
resp.data_set_import_tasks[0].summary.failed #=> Integer
resp.data_set_import_tasks[0].summary.in_progress #=> Integer
resp.data_set_import_tasks[0].summary.pending #=> Integer
resp.data_set_import_tasks[0].summary.succeeded #=> Integer
resp.data_set_import_tasks[0].summary.total #=> Integer
resp.data_set_import_tasks[0].task_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application.

  • :max_results (Integer) —

    The maximum number of objects to return.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Returns:

See Also:



1659
1660
1661
1662
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1659

def list_data_set_import_history(params = {}, options = {})
  req = build_request(:list_data_set_import_history, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_data_sets({
  application_id: "Identifier", # required
  max_results: 1,
  name_filter: "String200",
  next_token: "NextToken",
  prefix: "String200",
})

Response structure


resp.data_sets #=> Array
resp.data_sets[0].creation_time #=> Time
resp.data_sets[0].data_set_name #=> String
resp.data_sets[0].data_set_org #=> String
resp.data_sets[0].format #=> String
resp.data_sets[0].last_referenced_time #=> Time
resp.data_sets[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application for which you want to list the associated data sets.

  • :max_results (Integer) —

    The maximum number of objects to return.

  • :name_filter (String) —

    Filter dataset name matching the specified pattern. Can use * and % as wild cards.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

  • :prefix (String) —

    The prefix of the data set name, which you can use to filter the list of data sets.

Returns:

See Also:



1727
1728
1729
1730
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1727

def list_data_sets(params = {}, options = {})
  req = build_request(:list_data_sets, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_deployments({
  application_id: "Identifier", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.deployments #=> Array
resp.deployments[0].application_id #=> String
resp.deployments[0].application_version #=> Integer
resp.deployments[0].creation_time #=> Time
resp.deployments[0].deployment_id #=> String
resp.deployments[0].environment_id #=> String
resp.deployments[0].status #=> String, one of "Deploying", "Succeeded", "Failed", "Updating Deployment"
resp.deployments[0].status_reason #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application identifier.

  • :max_results (Integer) —

    The maximum number of objects to return.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Returns:

See Also:



1779
1780
1781
1782
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1779

def list_deployments(params = {}, options = {})
  req = build_request(:list_deployments, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_engine_versions({
  engine_type: "microfocus", # accepts microfocus, bluage
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.engine_versions #=> Array
resp.engine_versions[0].engine_type #=> String
resp.engine_versions[0].engine_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine_type (String) —

    The type of target platform.

  • :max_results (Integer) —

    The maximum number of objects to return.

  • :next_token (String) —

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Returns:

See Also:



1823
1824
1825
1826
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1823

def list_engine_versions(params = {}, options = {})
  req = build_request(:list_engine_versions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_environments({
  engine_type: "microfocus", # accepts microfocus, bluage
  max_results: 1,
  names: ["EntityName"],
  next_token: "NextToken",
})

Response structure


resp.environments #=> Array
resp.environments[0].creation_time #=> Time
resp.environments[0].engine_type #=> String, one of "microfocus", "bluage"
resp.environments[0].engine_version #=> String
resp.environments[0].environment_arn #=> String
resp.environments[0].environment_id #=> String
resp.environments[0].instance_type #=> String
resp.environments[0].name #=> String
resp.environments[0].status #=> String, one of "Creating", "Available", "Updating", "Deleting", "Failed"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine_type (String) —

    The engine type for the runtime environment.

  • :max_results (Integer) —

    The maximum number of runtime environments to return.

  • :names (Array<String>) —

    The names of the runtime environments. Must be unique within the account.

  • :next_token (String) —

    A pagination token to control the number of runtime environments displayed in the list.

Returns:

See Also:



1877
1878
1879
1880
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1877

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

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

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # 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:



1906
1907
1908
1909
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1906

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

#start_application(params = {}) ⇒ Struct

Starts an application that is currently stopped.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application you want to start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1928
1929
1930
1931
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1928

def start_application(params = {}, options = {})
  req = build_request(:start_application, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_batch_job({
  application_id: "Identifier", # required
  batch_job_identifier: { # required
    file_batch_job_identifier: {
      file_name: "String", # required
      folder_path: "String",
    },
    restart_batch_job_identifier: {
      execution_id: "Identifier", # required
      job_step_restart_marker: { # required
        from_proc_step: "String",
        from_step: "String", # required
        to_proc_step: "String",
        to_step: "String",
      },
    },
    s3_batch_job_identifier: {
      bucket: "String", # required
      identifier: { # required
        file_name: "String",
        script_name: "String",
      },
      key_prefix: "String",
    },
    script_batch_job_identifier: {
      script_name: "String", # required
    },
  },
  job_params: {
    "BatchParamKey" => "BatchParamValue",
  },
})

Response structure


resp.execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application associated with this batch job.

  • :batch_job_identifier (required, Types::BatchJobIdentifier) —

    The unique identifier of the batch job.

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

    The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 1999

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

#stop_application(params = {}) ⇒ Struct

Stops a running application.

Examples:

Request syntax with placeholder values


resp = client.stop_application({
  application_id: "Identifier", # required
  force_stop: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application you want to stop.

  • :force_stop (Boolean) —

    Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2028
2029
2030
2031
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2028

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

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # 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 to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2056
2057
2058
2059
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2056

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # 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>) —

    The keys of the tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2082
2083
2084
2085
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2082

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

#update_application(params = {}) ⇒ Types::UpdateApplicationResponse

Updates an application and creates a new version.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  application_id: "Identifier", # required
  current_application_version: 1, # required
  definition: {
    content: "StringFree65000",
    s3_location: "String2000",
  },
  description: "EntityDescription",
})

Response structure


resp.application_version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The unique identifier of the application you want to update.

  • :current_application_version (required, Integer) —

    The current version of the application to update.

  • :definition (Types::Definition) —

    The application definition for this application. You can specify either inline JSON or an S3 bucket location.

  • :description (String) —

    The description of the application to update.

Returns:

See Also:



2126
2127
2128
2129
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2126

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

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentResponse

Updates the configuration details for a specific runtime environment.

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  apply_during_maintenance_window: false,
  desired_capacity: 1,
  engine_version: "EngineVersion",
  environment_id: "Identifier", # required
  force_update: false,
  instance_type: "String20",
  preferred_maintenance_window: "String",
})

Response structure


resp.environment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :apply_during_maintenance_window (Boolean) —

    Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

  • :desired_capacity (Integer) —

    The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

  • :engine_version (String) —

    The version of the runtime engine for the runtime environment.

  • :environment_id (required, String) —

    The unique identifier of the runtime environment that you want to update.

  • :force_update (Boolean) —

    Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

    If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

    This option is not needed if the attribute being updated is preferredMaintenanceWindow.

  • :instance_type (String) —

    The instance type for the runtime environment to update.

  • :preferred_maintenance_window (String) —

    Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

    If you do not provide a value, a random system-generated value will be assigned.

Returns:

See Also:



2201
2202
2203
2204
 
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/client.rb', line 2201

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