You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.M2

Inherits:
AWS.Service show all
Identifier:
m2
API Version:
2021-04-28
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.

Sending a Request Using M2

var m2 = new AWS.M2();
m2.cancelBatchJobExecution(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the M2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var m2 = new AWS.M2({apiVersion: '2021-04-28'});

You can also set the API version globally in AWS.config.apiVersions using the m2 service identifier:

AWS.config.apiVersions = {
  m2: '2021-04-28',
  // other service API versions
};

var m2 = new AWS.M2();

Version:

  • 2021-04-28

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.M2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a M2 object

var m2 = new AWS.M2({apiVersion: '2021-04-28'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.M2.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.M2.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.M2.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelBatchJobExecution(params = {}, callback) ⇒ AWS.Request

Cancels the running of a specific batch job execution.

Service Reference:

Examples:

Calling the cancelBatchJobExecution operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  executionId: 'STRING_VALUE' /* required */
};
m2.cancelBatchJobExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • executionId — (String)

      The unique identifier of the batch job execution.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  definition: { /* required */
    content: 'STRING_VALUE',
    s3Location: 'STRING_VALUE'
  },
  engineType: microfocus | bluage, /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
m2.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • definition — (map)

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

      • content — (String)

        The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

      • s3Location — (String)

        The S3 bucket that contains the application definition.

    • description — (String)

      The description of the application.

    • engineType — (String)

      The type of the target platform for this application.

      Possible values include:
      • "microfocus"
      • "bluage"
    • name — (String)

      The unique identifier of the application.

    • tags — (map<String>)

      A list of tags to apply to the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationArn — (String)

        The Amazon Resource Name (ARN) of the application.

      • applicationId — (String)

        The unique application identifier.

      • applicationVersion — (Integer)

        The version number of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataSetImportTask(params = {}, callback) ⇒ AWS.Request

Starts a data set import task for a specific application.

Service Reference:

Examples:

Calling the createDataSetImportTask operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  importConfig: { /* required */
    dataSets: [
      {
        dataSet: { /* required */
          datasetName: 'STRING_VALUE', /* required */
          datasetOrg: { /* required */
            gdg: {
              limit: 'NUMBER_VALUE',
              rollDisposition: 'STRING_VALUE'
            },
            vsam: {
              format: 'STRING_VALUE', /* required */
              alternateKeys: [
                {
                  length: 'NUMBER_VALUE', /* required */
                  offset: 'NUMBER_VALUE', /* required */
                  allowDuplicates: true || false,
                  name: 'STRING_VALUE'
                },
                /* more items */
              ],
              compressed: true || false,
              encoding: 'STRING_VALUE',
              primaryKey: {
                length: 'NUMBER_VALUE', /* required */
                offset: 'NUMBER_VALUE', /* required */
                name: 'STRING_VALUE'
              }
            }
          },
          recordLength: { /* required */
            max: 'NUMBER_VALUE', /* required */
            min: 'NUMBER_VALUE' /* required */
          },
          relativePath: 'STRING_VALUE',
          storageType: 'STRING_VALUE'
        },
        externalLocation: { /* required */
          s3Location: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    s3Location: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE'
};
m2.createDataSetImportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

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

    • clientToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • importConfig — (map)

      The data set import task configuration.

      • dataSets — (Array<map>)

        The data sets.

        • dataSetrequired — (map)

          The data set.

          • datasetNamerequired — (String)

            The logical identifier for a specific data set (in mainframe format).

          • datasetOrgrequired — (map)

            The type of dataset. Possible values include VSAM, IS, PS, GDG, PO, PS, UNKNOWN etc.

            • gdg — (map)

              The generation data group of the data set.

              • limit — (Integer)

                The maximum number of generation data sets, up to 255, in a GDG.

              • rollDisposition — (String)

                The disposition of the data set in the catalog.

            • vsam — (map)

              The details of a VSAM data set.

              • alternateKeys — (Array<map>)

                The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

                • allowDuplicates — (Boolean)

                  Indicates whether the alternate key values are supposed to be unique for the given data set.

                • lengthrequired — (Integer)

                  A strictly positive integer value representing the length of the alternate key.

                • name — (String)

                  The name of the alternate key.

                • offsetrequired — (Integer)

                  A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

              • compressed — (Boolean)

                Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

              • encoding — (String)

                The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

              • formatrequired — (String)

                The record format of the data set.

              • primaryKey — (map)

                The primary key of the data set.

                • lengthrequired — (Integer)

                  A strictly positive integer value representing the length of the primary key.

                • name — (String)

                  A name for the Primary Key.

                • offsetrequired — (Integer)

                  A positive integer value representing the offset to mark the start of the primary key in the record byte array.

          • recordLengthrequired — (map)

            The length of a record.

            • maxrequired — (Integer)

              The maximum record length. In case of fixed, both minimum and maximum are the same.

            • minrequired — (Integer)

              The minimum record length of a record.

          • relativePath — (String)

            The relative location of the data set in the database or file system.

          • storageType — (String)

            The storage type of the data set: database or file system. For Micro Focus, database corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no support of file system and database corresponds to Blusam.

        • externalLocationrequired — (map)

          The location of the data set.

          • s3Location — (String)

            The URI of the Amazon S3 bucket.

      • s3Location — (String)

        The Amazon S3 location of the data sets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • taskId — (String)

        The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDeployment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createDeployment operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  applicationVersion: 'NUMBER_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
m2.createDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The application identifier.

    • applicationVersion — (Integer)

      The version of the application to deploy.

    • clientToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentId — (String)

      The identifier of the environment where this application will be deployed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deploymentId — (String)

        The unique identifier of the deployment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironment(params = {}, callback) ⇒ AWS.Request

Creates a runtime environment for a given runtime engine.

Service Reference:

Examples:

Calling the createEnvironment operation

var params = {
  engineType: microfocus | bluage, /* required */
  instanceType: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  engineVersion: 'STRING_VALUE',
  highAvailabilityConfig: {
    desiredCapacity: 'NUMBER_VALUE' /* required */
  },
  preferredMaintenanceWindow: 'STRING_VALUE',
  publiclyAccessible: true || false,
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  storageConfigurations: [
    {
      efs: {
        fileSystemId: 'STRING_VALUE', /* required */
        mountPoint: 'STRING_VALUE' /* required */
      },
      fsx: {
        fileSystemId: 'STRING_VALUE', /* required */
        mountPoint: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
m2.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      The description of the environment.

    • engineType — (String)

      The engine type for the environment.

      Possible values include:
      • "microfocus"
      • "bluage"
    • engineVersion — (String)

      The version of the engine type for the environment.

    • highAvailabilityConfig — (map)

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

      • desiredCapacityrequired — (Integer)

        The number of instances in a high availability configuration.

    • instanceType — (String)

      The type of instance for the environment.

    • name — (String)

      The unique identifier of the environment.

    • preferredMaintenanceWindow — (String)

      Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

    • publiclyAccessible — (Boolean)

      Specifies whether the environment is publicly accessible.

    • securityGroupIds — (Array<String>)

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

    • storageConfigurations — (Array<map>)

      Optional. The storage configurations for this environment.

      • efs — (map)

        Defines the storage configuration for an Amazon EFS file system.

        • fileSystemIdrequired — (String)

          The file system identifier.

        • mountPointrequired — (String)

          The mount point for the file system.

      • fsx — (map)

        Defines the storage configuration for an Amazon FSx file system.

        • fileSystemIdrequired — (String)

          The file system identifier.

        • mountPointrequired — (String)

          The mount point for the file system.

    • subnetIds — (Array<String>)

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

    • tags — (map<String>)

      The tags for the environment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentId — (String)

        The identifier of this environment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
m2.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteApplicationFromEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes a specific application from a specified environment where it has been previously deployed. You cannot delete an environment using DeleteEnvironment, if any application has ever been deployed to it. This API removes the association of the application with the environment so you can delete the environment smoothly.

Examples:

Calling the deleteApplicationFromEnvironment operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
m2.deleteApplicationFromEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application you want to delete.

    • environmentId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes a specific environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.

Service Reference:

Examples:

Calling the deleteEnvironment operation

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
m2.deleteEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplication(params = {}, callback) ⇒ AWS.Request

Describes the details of a specific application.

Service Reference:

Examples:

Calling the getApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
m2.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The identifier of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationArn — (String)

        The Amazon Resource Name (ARN) of the application.

      • applicationId — (String)

        The identifier of the application.

      • creationTime — (Date)

        The timestamp when this application was created.

      • deployedVersion — (map)

        The version of the application that is deployed.

        • applicationVersionrequired — (Integer)

          The version of the deployed application.

        • statusrequired — (String)

          The status of the deployment.

          Possible values include:
          • "Deploying"
          • "Succeeded"
          • "Failed"
        • statusReason — (String)

          The reason for the reported status.

      • description — (String)

        The description of the application.

      • engineType — (String)

        The type of the target platform for the application.

        Possible values include:
        • "microfocus"
        • "bluage"
      • environmentId — (String)

        The identifier of the environment where the application will be deployed.

      • lastStartTime — (Date)

        The timestamp when the application was last started. Null until the application has started running for the first time.

      • latestVersion — (map)

        The latest version of the application.

        • applicationVersionrequired — (Integer)

          The application version.

        • creationTimerequired — (Date)

          The timestamp when the application version was created.

        • statusrequired — (String)

          The status of the application.

          Possible values include:
          • "Creating"
          • "Available"
          • "Failed"
        • statusReason — (String)

          The reason for the reported status.

      • listenerArns — (Array<String>)

        The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener on your behalf the first time you deploy an application.

      • listenerPorts — (Array<Integer>)

        The port associated with the network load balancer listener created in your Amazon Web Services account.

      • loadBalancerDnsName — (String)

        The public DNS name of the load balancer created in your Amazon Web Services account.

      • logGroups — (Array<map>)

        The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. The Amazon Web Services Mainframe Modernization application log is pushed to CloudWatch under the customer's account.

        • logGroupNamerequired — (String)

          The name of the log group.

        • logTyperequired — (String)

          The type of log.

      • name — (String)

        The unique identifier of the application.

      • status — (String)

        The status of the application.

        Possible values include:
        • "Creating"
        • "Created"
        • "Available"
        • "Ready"
        • "Starting"
        • "Running"
        • "Stopping"
        • "Stopped"
        • "Failed"
        • "Deleting"
      • statusReason — (String)

        The reason for the reported status.

      • tags — (map<String>)

        A list of tags associated with the application.

      • targetGroupArns — (Array<String>)

        Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplicationVersion(params = {}, callback) ⇒ AWS.Request

Returns details about a specific version of a specific application.

Service Reference:

Examples:

Calling the getApplicationVersion operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  applicationVersion: 'NUMBER_VALUE' /* required */
};
m2.getApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • applicationVersion — (Integer)

      The specific version of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationVersion — (Integer)

        The specific version of the application.

      • creationTime — (Date)

        The timestamp when the application version was created.

      • definitionContent — (String)

        The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

      • description — (String)

        The application description.

      • name — (String)

        The name of the application version.

      • status — (String)

        The status of the application version.

        Possible values include:
        • "Creating"
        • "Available"
        • "Failed"
      • statusReason — (String)

        The reason for the reported status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBatchJobExecution(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getBatchJobExecution operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  executionId: 'STRING_VALUE' /* required */
};
m2.getBatchJobExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The identifier of the application.

    • executionId — (String)

      The unique identifier of the batch job execution.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationId — (String)

        The identifier of the application.

      • endTime — (Date)

        The timestamp when the batch job execution ended.

      • executionId — (String)

        The unique identifier for this batch job execution.

      • jobId — (String)

        The unique identifier for this batch job.

      • jobName — (String)

        The name of this batch job.

      • jobType — (String)

        The type of job.

        Possible values include:
        • "VSE"
        • "JES2"
        • "JES3"
      • jobUser — (String)

        The user for the job.

      • startTime — (Date)

        The timestamp when the batch job execution started.

      • status — (String)

        The status of the batch job execution.

        Possible values include:
        • "Submitting"
        • "Holding"
        • "Dispatching"
        • "Running"
        • "Cancelling"
        • "Cancelled"
        • "Succeeded"
        • "Failed"
        • "Succeeded With Warning"
      • statusReason — (String)

        The reason for the reported status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataSetDetails(params = {}, callback) ⇒ AWS.Request

Gets the details of a specific data set.

Service Reference:

Examples:

Calling the getDataSetDetails operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  dataSetName: 'STRING_VALUE' /* required */
};
m2.getDataSetDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

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

    • dataSetName — (String)

      The name of the data set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • blocksize — (Integer)

        The size of the block on disk.

      • creationTime — (Date)

        The timestamp when the data set was created.

      • dataSetName — (String)

        The name of the data set.

      • dataSetOrg — (map)

        The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

        • gdg — (map)

          The generation data group of the data set.

          • limit — (Integer)

            The maximum number of generation data sets, up to 255, in a GDG.

          • rollDisposition — (String)

            The disposition of the data set in the catalog.

        • vsam — (map)

          The details of a VSAM data set.

          • alternateKeys — (Array<map>)

            The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

            • allowDuplicates — (Boolean)

              Indicates whether the alternate key values are supposed to be unique for the given data set.

            • lengthrequired — (Integer)

              A strictly positive integer value representing the length of the alternate key.

            • name — (String)

              The name of the alternate key.

            • offsetrequired — (Integer)

              A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

          • cacheAtStartup — (Boolean)

            If set to True, enforces loading the data set into cache before it’s used by the application.

          • compressed — (Boolean)

            Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

          • encoding — (String)

            The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

          • primaryKey — (map)

            The primary key of the data set.

            • lengthrequired — (Integer)

              A strictly positive integer value representing the length of the primary key.

            • name — (String)

              A name for the Primary Key.

            • offsetrequired — (Integer)

              A positive integer value representing the offset to mark the start of the primary key in the record byte array.

          • recordFormat — (String)

            The record format of the data set.

      • lastReferencedTime — (Date)

        The last time the data set was referenced.

      • lastUpdatedTime — (Date)

        The last time the data set was updated.

      • location — (String)

        The locaion where the data set is stored.

      • recordLength — (Integer)

        The length of records in the data set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataSetImportTask(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDataSetImportTask operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  taskId: 'STRING_VALUE' /* required */
};
m2.getDataSetImportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The application identifier.

    • taskId — (String)

      The task identifier returned by the CreateDataSetImportTask operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The status of the task.

        Possible values include:
        • "Creating"
        • "Running"
        • "Completed"
      • summary — (map)

        A summary of the status of the task.

        • failedrequired — (Integer)

          The number of data set imports that have failed.

        • inProgressrequired — (Integer)

          The number of data set imports that are in progress.

        • pendingrequired — (Integer)

          The number of data set imports that are pending.

        • succeededrequired — (Integer)

          The number of data set imports that have succeeded.

        • totalrequired — (Integer)

          The total number of data set imports.

      • taskId — (String)

        The task identifier.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeployment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDeployment operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  deploymentId: 'STRING_VALUE' /* required */
};
m2.getDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • deploymentId — (String)

      The unique identifier for the deployment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationId — (String)

        The unique identifier of the application.

      • applicationVersion — (Integer)

        The application version.

      • creationTime — (Date)

        The timestamp when the deployment was created.

      • deploymentId — (String)

        The unique identifier of the deployment.

      • environmentId — (String)

        The unique identifier of the runtime environment.

      • status — (String)

        The status of the deployment.

        Possible values include:
        • "Deploying"
        • "Succeeded"
        • "Failed"
      • statusReason — (String)

        The reason for the reported status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironment(params = {}, callback) ⇒ AWS.Request

Describes a specific runtime environment.

Service Reference:

Examples:

Calling the getEnvironment operation

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
m2.getEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentId — (String)

      The unique identifier of the runtime environment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • actualCapacity — (Integer)

        The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

      • creationTime — (Date)

        The timestamp when the runtime environment was created.

      • description — (String)

        The description of the runtime environment.

      • engineType — (String)

        The target platform for the runtime environment.

        Possible values include:
        • "microfocus"
        • "bluage"
      • engineVersion — (String)

        The version of the runtime engine.

      • environmentArn — (String)

        The Amazon Resource Name (ARN) of the runtime environment.

      • environmentId — (String)

        The unique identifier of the runtime environment.

      • highAvailabilityConfig — (map)

        The desired capacity of the high availability configuration for the runtime environment.

        • desiredCapacityrequired — (Integer)

          The number of instances in a high availability configuration.

      • instanceType — (String)

        The type of instance underlying the runtime environment.

      • loadBalancerArn — (String)

        The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

      • name — (String)

        The name of the runtime environment.

      • pendingMaintenance — (map)

        Indicates the pending maintenance scheduled on this environment.

        • engineVersion — (String)

          The specific runtime engine that the maintenance schedule applies to.

        • schedule — (map)

          The maintenance schedule for the engine version.

          • endTime — (Date)

            The time the scheduled maintenance is to end.

          • startTime — (Date)

            The time the scheduled maintenance is to start.

      • preferredMaintenanceWindow — (String)

        Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

      • publiclyAccessible — (Boolean)

        Whether applications running in this runtime environment are publicly accessible.

      • securityGroupIds — (Array<String>)

        The unique identifiers of the security groups assigned to this runtime environment.

      • status — (String)

        The status of the runtime environment.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"
      • statusReason — (String)

        The reason for the reported status.

      • storageConfigurations — (Array<map>)

        The storage configurations defined for the runtime environment.

        • efs — (map)

          Defines the storage configuration for an Amazon EFS file system.

          • fileSystemIdrequired — (String)

            The file system identifier.

          • mountPointrequired — (String)

            The mount point for the file system.

        • fsx — (map)

          Defines the storage configuration for an Amazon FSx file system.

          • fileSystemIdrequired — (String)

            The file system identifier.

          • mountPointrequired — (String)

            The mount point for the file system.

      • subnetIds — (Array<String>)

        The unique identifiers of the subnets assigned to this runtime environment.

      • tags — (map<String>)

        The tags defined for this runtime environment.

      • vpcId — (String)

        The unique identifier for the VPC used with this runtime environment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific environment in a query parameter to see all applications associated with that environment.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  environmentId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  names: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE'
};
m2.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentId — (String)

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

    • maxResults — (Integer)

      The maximum number of applications to return.

    • names — (Array<String>)

      The names of the applications.

    • nextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applications — (Array<map>)

        Returns a list of summary details for all the applications in an environment.

        • applicationArnrequired — (String)

          The Amazon Resource Name (ARN) of the application.

        • applicationIdrequired — (String)

          The unique identifier of the application.

        • applicationVersionrequired — (Integer)

          The version of the application.

        • creationTimerequired — (Date)

          The timestamp when the application was created.

        • deploymentStatus — (String)

          Indicates whether there is an ongoing deployment or if the application has ever deployed successfully.

          Possible values include:
          • "Deploying"
          • "Deployed"
        • description — (String)

          The description of the application.

        • engineTyperequired — (String)

          The type of the target platform for this application.

          Possible values include:
          • "microfocus"
          • "bluage"
        • environmentId — (String)

          The unique identifier of the runtime environment that hosts this application.

        • lastStartTime — (Date)

          The timestamp when the application was last started. Null until the application has started running for the first time.

        • namerequired — (String)

          The name of the application.

        • statusrequired — (String)

          The status of the application.

          Possible values include:
          • "Creating"
          • "Created"
          • "Available"
          • "Ready"
          • "Starting"
          • "Running"
          • "Stopping"
          • "Stopped"
          • "Failed"
          • "Deleting"
        • versionStatus — (String)

          Indicates the status of the latest version of the application.

          Possible values include:
          • "Creating"
          • "Available"
          • "Failed"
      • nextToken — (String)

        A pagination token that's returned when the response doesn't contain all applications.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplicationVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of the application versions for a specific application.

Service Reference:

Examples:

Calling the listApplicationVersions operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
m2.listApplicationVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • maxResults — (Integer)

      The maximum number of application versions to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationVersions — (Array<map>)

        The list of application versions.

        • applicationVersionrequired — (Integer)

          The application version.

        • creationTimerequired — (Date)

          The timestamp when the application version was created.

        • statusrequired — (String)

          The status of the application.

          Possible values include:
          • "Creating"
          • "Available"
          • "Failed"
        • statusReason — (String)

          The reason for the reported status.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBatchJobDefinitions(params = {}, callback) ⇒ AWS.Request

Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. The listed batch job definitions can then be used to start a batch job.

Service Reference:

Examples:

Calling the listBatchJobDefinitions operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  prefix: 'STRING_VALUE'
};
m2.listBatchJobDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The identifier of the application.

    • maxResults — (Integer)

      The maximum number of batch job definitions to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • batchJobDefinitions — (Array<map>)

        The list of batch job definitions.

        • fileBatchJobDefinition — (map)

          Specifies a file containing a batch job definition.

          • fileNamerequired — (String)

            The name of the file containing the batch job definition.

          • folderPath — (String)

            The path to the file containing the batch job definition.

        • scriptBatchJobDefinition — (map)

          A script containing a batch job definition.

          • scriptNamerequired — (String)

            The name of the script containing the batch job definition.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBatchJobExecutions(params = {}, callback) ⇒ AWS.Request

Lists historical, current, and scheduled batch job executions for a specific application.

Service Reference:

Examples:

Calling the listBatchJobExecutions operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  executionIds: [
    'STRING_VALUE',
    /* more items */
  ],
  jobName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  startedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  startedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  status: Submitting | Holding | Dispatching | Running | Cancelling | Cancelled | Succeeded | Failed | Succeeded With Warning
};
m2.listBatchJobExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • executionIds — (Array<String>)

      The unique identifier of each batch job execution.

    • jobName — (String)

      The name of each batch job execution.

    • maxResults — (Integer)

      The maximum number of batch job executions to return.

    • nextToken — (String)

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

    • startedAfter — (Date)

      The time after which the batch job executions started.

    • startedBefore — (Date)

      The time before the batch job executions started.

    • status — (String)

      The status of the batch job executions.

      Possible values include:
      • "Submitting"
      • "Holding"
      • "Dispatching"
      • "Running"
      • "Cancelling"
      • "Cancelled"
      • "Succeeded"
      • "Failed"
      • "Succeeded With Warning"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • batchJobExecutions — (Array<map>)

        Returns a list of batch job executions for an application.

        • applicationIdrequired — (String)

          The unique identifier of the application that hosts this batch job.

        • endTime — (Date)

          The timestamp when this batch job execution ended.

        • executionIdrequired — (String)

          The unique identifier of this execution of the batch job.

        • jobId — (String)

          The unique identifier of a particular batch job.

        • jobName — (String)

          The name of a particular batch job.

        • jobType — (String)

          The type of a particular batch job execution.

          Possible values include:
          • "VSE"
          • "JES2"
          • "JES3"
        • startTimerequired — (Date)

          The timestamp when a particular batch job execution started.

        • statusrequired — (String)

          The status of a particular batch job execution.

          Possible values include:
          • "Submitting"
          • "Holding"
          • "Dispatching"
          • "Running"
          • "Cancelling"
          • "Cancelled"
          • "Succeeded"
          • "Failed"
          • "Succeeded With Warning"
      • nextToken — (String)

        A pagination token that's returned when the response doesn't contain all batch job executions.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSetImportHistory(params = {}, callback) ⇒ AWS.Request

Lists the data set imports for the specified application.

Service Reference:

Examples:

Calling the listDataSetImportHistory operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
m2.listDataSetImportHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application.

    • maxResults — (Integer)

      The maximum number of objects to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataSetImportTasks — (Array<map>)

        The data set import tasks.

        • statusrequired — (String)

          The status of the data set import task.

          Possible values include:
          • "Creating"
          • "Running"
          • "Completed"
        • summaryrequired — (map)

          A summary of the data set import task.

          • failedrequired — (Integer)

            The number of data set imports that have failed.

          • inProgressrequired — (Integer)

            The number of data set imports that are in progress.

          • pendingrequired — (Integer)

            The number of data set imports that are pending.

          • succeededrequired — (Integer)

            The number of data set imports that have succeeded.

          • totalrequired — (Integer)

            The total number of data set imports.

        • taskIdrequired — (String)

          The identifier of the data set import task.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSets(params = {}, callback) ⇒ AWS.Request

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

Service Reference:

Examples:

Calling the listDataSets operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  prefix: 'STRING_VALUE'
};
m2.listDataSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

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

    • maxResults — (Integer)

      The maximum number of objects to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataSets — (Array<map>)

        The list of data sets, containing ionformation including the creating time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.

        • creationTime — (Date)

          The timestamp when the data set was created.

        • dataSetNamerequired — (String)

          The name of the data set.

        • dataSetOrg — (String)

          The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

        • format — (String)

          The format of the data set.

        • lastReferencedTime — (Date)

          The last time the data set was referenced.

        • lastUpdatedTime — (Date)

          The last time the data set was updated.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeployments(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listDeployments operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
m2.listDeployments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The application identifier.

    • maxResults — (Integer)

      The maximum number of objects to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deployments — (Array<map>)

        The list of deployments that is returned.

        • applicationIdrequired — (String)

          The unique identifier of the application.

        • applicationVersionrequired — (Integer)

          The version of the application.

        • creationTimerequired — (Date)

          The timestamp when the deployment was created.

        • deploymentIdrequired — (String)

          The unique identifier of the deployment.

        • environmentIdrequired — (String)

          The unique identifier of the environment.

        • statusrequired — (String)

          The current status of the deployment.

          Possible values include:
          • "Deploying"
          • "Succeeded"
          • "Failed"
        • statusReason — (String)

          The reason for the reported status.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEngineVersions(params = {}, callback) ⇒ AWS.Request

Lists the available engine versions.

Service Reference:

Examples:

Calling the listEngineVersions operation

var params = {
  engineType: microfocus | bluage,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
m2.listEngineVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • engineType — (String)

      The type of target platform.

      Possible values include:
      • "microfocus"
      • "bluage"
    • maxResults — (Integer)

      The maximum number of objects to return.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • engineVersions — (Array<map>)

        Returns the engine versions.

        • engineTyperequired — (String)

          The type of target platform for the application.

        • engineVersionrequired — (String)

          The version of the engine type used by the application.

      • nextToken — (String)

        If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironments(params = {}, callback) ⇒ AWS.Request

Lists the runtime environments.

Service Reference:

Examples:

Calling the listEnvironments operation

var params = {
  engineType: microfocus | bluage,
  maxResults: 'NUMBER_VALUE',
  names: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE'
};
m2.listEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • engineType — (String)

      The engine type for the environment.

      Possible values include:
      • "microfocus"
      • "bluage"
    • maxResults — (Integer)

      The maximum number of environments to return.

    • names — (Array<String>)

      The name of the environment.

    • nextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environments — (Array<map>)

        Returns a list of summary details for all the environments in your account.

        • creationTimerequired — (Date)

          The timestamp when the environment was created.

        • engineTyperequired — (String)

          The target platform for the environment.

          Possible values include:
          • "microfocus"
          • "bluage"
        • engineVersionrequired — (String)

          The version of the runtime engine.

        • environmentArnrequired — (String)

          The Amazon Resource Name (ARN) of a particular runtime environment.

        • environmentIdrequired — (String)

          The unique identifier of a particular runtime environment.

        • instanceTyperequired — (String)

          The instance type of the environment.

        • namerequired — (String)

          The name of the environment.

        • statusrequired — (String)

          The status of the environment

          Possible values include:
          • "Creating"
          • "Available"
          • "Deleting"
          • "Failed"
      • nextToken — (String)

        A pagination token that's returned when the response doesn't contain all the environments.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
m2.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startApplication(params = {}, callback) ⇒ AWS.Request

Starts an application that is currently stopped.

Service Reference:

Examples:

Calling the startApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
m2.startApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application you want to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startBatchJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startBatchJob operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  batchJobIdentifier: { /* required */
    fileBatchJobIdentifier: {
      fileName: 'STRING_VALUE', /* required */
      folderPath: 'STRING_VALUE'
    },
    scriptBatchJobIdentifier: {
      scriptName: 'STRING_VALUE' /* required */
    }
  },
  jobParams: {
    '<BatchParamKey>': 'STRING_VALUE',
    /* '<BatchParamKey>': ... */
  }
};
m2.startBatchJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

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

    • batchJobIdentifier — (map)

      The unique identifier of the batch job.

      • fileBatchJobIdentifier — (map)

        Specifies a file associated with a specific batch job.

        • fileNamerequired — (String)

          The file name for the batch job identifier.

        • folderPath — (String)

          The relative path to the file name for the batch job identifier.

      • scriptBatchJobIdentifier — (map)

        A batch job identifier in which the batch job to run is identified by the script name.

        • scriptNamerequired — (String)

          The name of the script containing the batch job definition.

    • jobParams — (map<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • executionId — (String)

        The unique identifier of this execution of the batch job.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopApplication(params = {}, callback) ⇒ AWS.Request

Stops a running application.

Service Reference:

Examples:

Calling the stopApplication operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  forceStop: true || false
};
m2.stopApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application you want to stop.

    • forceStop — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
m2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags to add to the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
m2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The keys of the tags to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates an application and creates a new version.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  currentApplicationVersion: 'NUMBER_VALUE', /* required */
  definition: {
    content: 'STRING_VALUE',
    s3Location: 'STRING_VALUE'
  },
  description: 'STRING_VALUE'
};
m2.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The unique identifier of the application you want to update.

    • currentApplicationVersion — (Integer)

      The current version of the application to update.

    • definition — (map)

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

      • content — (String)

        The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

      • s3Location — (String)

        The S3 bucket that contains the application definition.

    • description — (String)

      The description of the application to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationVersion — (Integer)

        The new version of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

Updates the configuration details for a specific environment.

Service Reference:

Examples:

Calling the updateEnvironment operation

var params = {
  environmentId: 'STRING_VALUE', /* required */
  applyDuringMaintenanceWindow: true || false,
  desiredCapacity: 'NUMBER_VALUE',
  engineVersion: 'STRING_VALUE',
  instanceType: 'STRING_VALUE',
  preferredMaintenanceWindow: 'STRING_VALUE'
};
m2.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applyDuringMaintenanceWindow — (Boolean)

      Indicates whether to update the 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.

    • desiredCapacity — (Integer)

      The desired capacity for the environment to update.

    • engineVersion — (String)

      The version of the runtime engine for the environment.

    • environmentId — (String)

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

    • instanceType — (String)

      The instance type for the environment to update.

    • preferredMaintenanceWindow — (String)

      Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentId — (String)

        The unique identifier of the runtime environment that was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.