Class: AWS.AppTest

var params = {
  name: 'STRING_VALUE', /* required */
  resources: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      type: { /* required */
        cloudFormation: {
          templateLocation: 'STRING_VALUE', /* required */
          parameters: {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          }
        },
        m2ManagedApplication: {
          applicationId: 'STRING_VALUE', /* required */
          runtime: MicroFocus, /* required */
          listenerPort: 'STRING_VALUE',
          vpcEndpointServiceName: 'STRING_VALUE'
        },
        m2NonManagedApplication: {
          listenerPort: 'STRING_VALUE', /* required */
          runtime: BluAge, /* required */
          vpcEndpointServiceName: 'STRING_VALUE', /* required */
          webAppName: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  properties: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  serviceSettings: {
    kmsKeyId: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
apptest.createTestConfiguration(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: {}) —
  • name — (String)

    The name of the test configuration.

  • description — (String)

    The description of the test configuration.

  • resources — (Array<map>)

    The defined resources of the test configuration.

    • name — required — (String)

      The name of the resource.

    • type — required — (map)

      The type of the resource.

      • cloudFormation — (map)

        The CloudFormation template of the resource type.

        • templateLocation — required — (String)

          The template location of the CloudFormation template.

        • parameters — (map<String>)

          The CloudFormation properties in the CloudFormation template.

      • m2ManagedApplication — (map)

        The AWS Mainframe Modernization managed application of the resource type.

        • applicationId — required — (String)

          The application ID of the AWS Mainframe Modernization managed application.

        • runtime — required — (String)

          The runtime of the AWS Mainframe Modernization managed application.

          Possible values include:
          • "MicroFocus"
        • vpcEndpointServiceName — (String)

          The VPC endpoint service name of the AWS Mainframe Modernization managed application.

        • listenerPort — (String)

          The listener port of the AWS Mainframe Modernization managed application.

      • m2NonManagedApplication — (map)

        The AWS Mainframe Modernization non-managed application of the resource type.

        • vpcEndpointServiceName — required — (String)

          The VPC endpoint service name of the AWS Mainframe Modernization non-managed application.

        • listenerPort — required — (String)

          The listener port of the AWS Mainframe Modernization non-managed application.

        • runtime — required — (String)

          The runtime of the AWS Mainframe Modernization non-managed application.

          Possible values include:
          • "BluAge"
        • webAppName — (String)

          The web application name of the AWS Mainframe Modernization non-managed application.

  • properties — (map<String>)

    The properties of the test configuration.

  • clientToken — (String)

    The client token of the test configuration.

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

    The tags of the test configuration.

  • serviceSettings — (map)

    The service settings of the test configuration.

    • kmsKeyId — (String)

      The KMS key ID of the service settings.

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:

    • testConfigurationId — (String)

      The test configuration ID.

    • testConfigurationVersion — (Integer)

      The test configuration version.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  testCases: { /* required */
    sequential: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  afterSteps: [
    {
      action: { /* required */
        compareAction: {
          input: { /* required */
            file: {
              fileMetadata: { /* required */
                dataSets: [
                  {
                    ccsid: 'STRING_VALUE', /* required */
                    format: FIXED | VARIABLE | LINE_SEQUENTIAL, /* required */
                    length: 'NUMBER_VALUE', /* required */
                    name: 'STRING_VALUE', /* required */
                    type: PS /* required */
                  },
                  /* more items */
                ],
                databaseCDC: {
                  sourceMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: z/OS-DB2 /* required */
                  },
                  targetMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: PostgreSQL /* required */
                  }
                }
              },
              sourceLocation: 'STRING_VALUE', /* required */
              targetLocation: 'STRING_VALUE' /* required */
            }
          },
          output: {
            file: {
              fileLocation: 'STRING_VALUE'
            }
          }
        },
        mainframeAction: {
          actionType: { /* required */
            batch: {
              batchJobName: 'STRING_VALUE', /* required */
              batchJobParameters: {
                '<String>': 'STRING_VALUE',
                /* '<String>': ... */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tn3270: {
              script: { /* required */
                scriptLocation: 'STRING_VALUE', /* required */
                type: Selenium /* required */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          resource: 'STRING_VALUE', /* required */
          properties: {
            dmsTaskArn: 'STRING_VALUE'
          }
        },
        resourceAction: {
          cloudFormationAction: {
            resource: 'STRING_VALUE', /* required */
            actionType: Create | Delete
          },
          m2ManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE', /* required */
            properties: {
              forceStop: true || false,
              importDataSetLocation: 'STRING_VALUE'
            }
          },
          m2NonManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE' /* required */
          }
        }
      },
      name: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  beforeSteps: [
    {
      action: { /* required */
        compareAction: {
          input: { /* required */
            file: {
              fileMetadata: { /* required */
                dataSets: [
                  {
                    ccsid: 'STRING_VALUE', /* required */
                    format: FIXED | VARIABLE | LINE_SEQUENTIAL, /* required */
                    length: 'NUMBER_VALUE', /* required */
                    name: 'STRING_VALUE', /* required */
                    type: PS /* required */
                  },
                  /* more items */
                ],
                databaseCDC: {
                  sourceMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: z/OS-DB2 /* required */
                  },
                  targetMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: PostgreSQL /* required */
                  }
                }
              },
              sourceLocation: 'STRING_VALUE', /* required */
              targetLocation: 'STRING_VALUE' /* required */
            }
          },
          output: {
            file: {
              fileLocation: 'STRING_VALUE'
            }
          }
        },
        mainframeAction: {
          actionType: { /* required */
            batch: {
              batchJobName: 'STRING_VALUE', /* required */
              batchJobParameters: {
                '<String>': 'STRING_VALUE',
                /* '<String>': ... */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tn3270: {
              script: { /* required */
                scriptLocation: 'STRING_VALUE', /* required */
                type: Selenium /* required */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          resource: 'STRING_VALUE', /* required */
          properties: {
            dmsTaskArn: 'STRING_VALUE'
          }
        },
        resourceAction: {
          cloudFormationAction: {
            resource: 'STRING_VALUE', /* required */
            actionType: Create | Delete
          },
          m2ManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE', /* required */
            properties: {
              forceStop: true || false,
              importDataSetLocation: 'STRING_VALUE'
            }
          },
          m2NonManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE' /* required */
          }
        }
      },
      name: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
apptest.createTestSuite(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: {}) —
  • name — (String)

    The name of the test suite.

  • description — (String)

    The description of the test suite.

  • beforeSteps — (Array<map>)

    The before steps of the test suite.

    • name — required — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • action — required — (map)

      The action of the step.

      • resourceAction — (map)

        The resource action of the step action.

        • m2ManagedApplicationAction — (map)

          The AWS Mainframe Modernization managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
          • properties — (map)

            The properties of the AWS Mainframe Modernization managed application action.

            • forceStop — (Boolean)

              Force stops the AWS Mainframe Modernization managed action properties.

            • importDataSetLocation — (String)

              The import data set location of the AWS Mainframe Modernization managed action properties.

        • m2NonManagedApplicationAction — (map)

          The AWS Mainframe Modernization non-managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization non-managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization non-managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
        • cloudFormationAction — (map)

          The CloudFormation action of the resource action.

          • resource — required — (String)

            The resource of the CloudFormation action.

          • actionType — (String)

            The action type of the CloudFormation action.

            Possible values include:
            • "Create"
            • "Delete"
      • mainframeAction — (map)

        The mainframe action of the step action.

        • resource — required — (String)

          The resource of the mainframe action.

        • actionType — required — (map)

          The action type of the mainframe action.

          • batch — (map)

            The batch of the mainframe action type.

            • batchJobName — required — (String)

              The job name of the batch.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch.

          • tn3270 — (map)

            The tn3270 port of the mainframe action type.

            • script — required — (map)

              The script of the TN3270 protocol.

              • scriptLocation — required — (String)

                The script location of the scripts.

              • type — required — (String)

                The type of the scripts.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The data set names of the TN3270 protocol.

        • properties — (map)

          The properties of the mainframe action.

          • dmsTaskArn — (String)

            The DMS task ARN of the mainframe action properties.

      • compareAction — (map)

        The compare action of the step action.

        • input — required — (map)

          The input of the compare action.

          • file — (map)

            The file in the input.

            • sourceLocation — required — (String)

              The source location of the input file.

            • targetLocation — required — (String)

              The target location of the input file.

            • fileMetadata — required — (map)

              The file metadata of the input file.

              • dataSets — (Array<map>)

                The data sets of the file metadata.

                • type — required — (String)

                  The type of the data set.

                  Possible values include:
                  • "PS"
                • name — required — (String)

                  The name of the data set.

                • ccsid — required — (String)

                  The CCSID of the data set.

                • format — required — (String)

                  The format of the data set.

                  Possible values include:
                  • "FIXED"
                  • "VARIABLE"
                  • "LINE_SEQUENTIAL"
                • length — required — (Integer)

                  The length of the data set.

              • databaseCDC — (map)

                The database CDC of the file metadata.

                • sourceMetadata — required — (map)

                  The source metadata of the database CDC.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata of the database CDC.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
        • output — (map)

          The output of the compare action.

          • file — (map)

            The file of the output.

            • fileLocation — (String)

              The file location of the output file.

  • afterSteps — (Array<map>)

    The after steps of the test suite.

    • name — required — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • action — required — (map)

      The action of the step.

      • resourceAction — (map)

        The resource action of the step action.

        • m2ManagedApplicationAction — (map)

          The AWS Mainframe Modernization managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
          • properties — (map)

            The properties of the AWS Mainframe Modernization managed application action.

            • forceStop — (Boolean)

              Force stops the AWS Mainframe Modernization managed action properties.

            • importDataSetLocation — (String)

              The import data set location of the AWS Mainframe Modernization managed action properties.

        • m2NonManagedApplicationAction — (map)

          The AWS Mainframe Modernization non-managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization non-managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization non-managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
        • cloudFormationAction — (map)

          The CloudFormation action of the resource action.

          • resource — required — (String)

            The resource of the CloudFormation action.

          • actionType — (String)

            The action type of the CloudFormation action.

            Possible values include:
            • "Create"
            • "Delete"
      • mainframeAction — (map)

        The mainframe action of the step action.

        • resource — required — (String)

          The resource of the mainframe action.

        • actionType — required — (map)

          The action type of the mainframe action.

          • batch — (map)

            The batch of the mainframe action type.

            • batchJobName — required — (String)

              The job name of the batch.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch.

          • tn3270 — (map)

            The tn3270 port of the mainframe action type.

            • script — required — (map)

              The script of the TN3270 protocol.

              • scriptLocation — required — (String)

                The script location of the scripts.

              • type — required — (String)

                The type of the scripts.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The data set names of the TN3270 protocol.

        • properties — (map)

          The properties of the mainframe action.

          • dmsTaskArn — (String)

            The DMS task ARN of the mainframe action properties.

      • compareAction — (map)

        The compare action of the step action.

        • input — required — (map)

          The input of the compare action.

          • file — (map)

            The file in the input.

            • sourceLocation — required — (String)

              The source location of the input file.

            • targetLocation — required — (String)

              The target location of the input file.

            • fileMetadata — required — (map)

              The file metadata of the input file.

              • dataSets — (Array<map>)

                The data sets of the file metadata.

                • type — required — (String)

                  The type of the data set.

                  Possible values include:
                  • "PS"
                • name — required — (String)

                  The name of the data set.

                • ccsid — required — (String)

                  The CCSID of the data set.

                • format — required — (String)

                  The format of the data set.

                  Possible values include:
                  • "FIXED"
                  • "VARIABLE"
                  • "LINE_SEQUENTIAL"
                • length — required — (Integer)

                  The length of the data set.

              • databaseCDC — (map)

                The database CDC of the file metadata.

                • sourceMetadata — required — (map)

                  The source metadata of the database CDC.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata of the database CDC.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
        • output — (map)

          The output of the compare action.

          • file — (map)

            The file of the output.

            • fileLocation — (String)

              The file location of the output file.

  • testCases — (map)

    The test cases in the test suite.

    • sequential — (Array<String>)

      The sequential of the test case.

  • clientToken — (String)

    The client token of the test suite.

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

    The tags of the test suite.

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:

    • testSuiteId — (String)

      The suite ID of the test suite.

    • testSuiteVersion — (Integer)

      The suite version of the test suite.

Returns:

• (AWS.Request) —

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

var params = {
  testCaseId: 'STRING_VALUE' /* required */
};
apptest.deleteTestCase(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: {}) —
  • testCaseId — (String)

    The test case ID of the test case.

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.

var params = {
  testConfigurationId: 'STRING_VALUE' /* required */
};
apptest.deleteTestConfiguration(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: {}) —
  • testConfigurationId — (String)

    The test ID of the test configuration.

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.

var params = {
  testRunId: 'STRING_VALUE' /* required */
};
apptest.deleteTestRun(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: {}) —
  • testRunId — (String)

    The run ID of the test run.

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.

var params = {
  testSuiteId: 'STRING_VALUE' /* required */
};
apptest.deleteTestSuite(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: {}) —
  • testSuiteId — (String)

    The test ID of the test suite.

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.

var params = {
  testCaseId: 'STRING_VALUE', /* required */
  testCaseVersion: 'NUMBER_VALUE'
};
apptest.getTestCase(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: {}) —
  • testCaseId — (String)

    The request test ID of the test case.

  • testCaseVersion — (Integer)

    The test case version of the test case.

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:

    • testCaseId — (String)

      The response test ID of the test case.

    • testCaseArn — (String)

      The Amazon Resource Name (ARN) of the test case.

    • name — (String)

      The name of the test case.

    • description — (String)

      The description of the test case.

    • latestVersion — (map)

      The latest version of the test case.

      • version — required — (Integer)

        The version of the test case latest version.

      • status — required — (String)

        The status of the test case latest version.

        Possible values include:
        • "Active"
        • "Deleting"
      • statusReason — (String)

        The status reason of the test case latest version.

    • testCaseVersion — (Integer)

      The case version of the test case.

    • status — (String)

      The status of the test case.

      Possible values include:
      • "Active"
      • "Deleting"
    • statusReason — (String)

      The status reason of the test case.

    • creationTime — (Date)

      The creation time of the test case.

    • lastUpdateTime — (Date)

      The last update time of the test case.

    • steps — (Array<map>)

      The steps of the test case.

      • name — required — (String)

        The name of the step.

      • description — (String)

        The description of the step.

      • action — required — (map)

        The action of the step.

        • resourceAction — (map)

          The resource action of the step action.

          • m2ManagedApplicationAction — (map)

            The AWS Mainframe Modernization managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
            • properties — (map)

              The properties of the AWS Mainframe Modernization managed application action.

              • forceStop — (Boolean)

                Force stops the AWS Mainframe Modernization managed action properties.

              • importDataSetLocation — (String)

                The import data set location of the AWS Mainframe Modernization managed action properties.

          • m2NonManagedApplicationAction — (map)

            The AWS Mainframe Modernization non-managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization non-managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization non-managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
          • cloudFormationAction — (map)

            The CloudFormation action of the resource action.

            • resource — required — (String)

              The resource of the CloudFormation action.

            • actionType — (String)

              The action type of the CloudFormation action.

              Possible values include:
              • "Create"
              • "Delete"
        • mainframeAction — (map)

          The mainframe action of the step action.

          • resource — required — (String)

            The resource of the mainframe action.

          • actionType — required — (map)

            The action type of the mainframe action.

            • batch — (map)

              The batch of the mainframe action type.

              • batchJobName — required — (String)

                The job name of the batch.

              • batchJobParameters — (map<String>)

                The batch job parameters of the batch.

              • exportDataSetNames — (Array<String>)

                The export data set names of the batch.

            • tn3270 — (map)

              The tn3270 port of the mainframe action type.

              • script — required — (map)

                The script of the TN3270 protocol.

                • scriptLocation — required — (String)

                  The script location of the scripts.

                • type — required — (String)

                  The type of the scripts.

                  Possible values include:
                  • "Selenium"
              • exportDataSetNames — (Array<String>)

                The data set names of the TN3270 protocol.

          • properties — (map)

            The properties of the mainframe action.

            • dmsTaskArn — (String)

              The DMS task ARN of the mainframe action properties.

        • compareAction — (map)

          The compare action of the step action.

          • input — required — (map)

            The input of the compare action.

            • file — (map)

              The file in the input.

              • sourceLocation — required — (String)

                The source location of the input file.

              • targetLocation — required — (String)

                The target location of the input file.

              • fileMetadata — required — (map)

                The file metadata of the input file.

                • dataSets — (Array<map>)

                  The data sets of the file metadata.

                  • type — required — (String)

                    The type of the data set.

                    Possible values include:
                    • "PS"
                  • name — required — (String)

                    The name of the data set.

                  • ccsid — required — (String)

                    The CCSID of the data set.

                  • format — required — (String)

                    The format of the data set.

                    Possible values include:
                    • "FIXED"
                    • "VARIABLE"
                    • "LINE_SEQUENTIAL"
                  • length — required — (Integer)

                    The length of the data set.

                • databaseCDC — (map)

                  The database CDC of the file metadata.

                  • sourceMetadata — required — (map)

                    The source metadata of the database CDC.

                    • type — required — (String)

                      The type of the source database metadata.

                      Possible values include:
                      • "z/OS-DB2"
                    • captureTool — required — (String)

                      The capture tool of the source database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
                  • targetMetadata — required — (map)

                    The target metadata of the database CDC.

                    • type — required — (String)

                      The type of the target database metadata.

                      Possible values include:
                      • "PostgreSQL"
                    • captureTool — required — (String)

                      The capture tool of the target database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
          • output — (map)

            The output of the compare action.

            • file — (map)

              The file of the output.

              • fileLocation — (String)

                The file location of the output file.

    • tags — (map<String>)

      The tags of the test case.

Returns:

• (AWS.Request) —

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

var params = {
  testConfigurationId: 'STRING_VALUE', /* required */
  testConfigurationVersion: 'NUMBER_VALUE'
};
apptest.getTestConfiguration(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: {}) —
  • testConfigurationId — (String)

    The request test configuration ID.

  • testConfigurationVersion — (Integer)

    The test configuration version.

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:

    • testConfigurationId — (String)

      The response test configuration ID.

    • name — (String)

      The test configuration name

    • testConfigurationArn — (String)

      The test configuration Amazon Resource Name (ARN).

    • latestVersion — (map)

      The latest version of the test configuration.

      • version — required — (Integer)

        The version of the test configuration latest version.

      • status — required — (String)

        The status of the test configuration latest version.

        Possible values include:
        • "Active"
        • "Deleting"
      • statusReason — (String)

        The status reason of the test configuration latest version.

    • testConfigurationVersion — (Integer)

      The test configuration version.

    • status — (String)

      The status of the test configuration.

      Possible values include:
      • "Active"
      • "Deleting"
    • statusReason — (String)

      The status reason of the test configuration.

    • creationTime — (Date)

      The creation time of the test configuration.

    • lastUpdateTime — (Date)

      The last update time of the test configuration.

    • description — (String)

      The description of the test configuration.

    • resources — (Array<map>)

      The resources of the test configuration.

      • name — required — (String)

        The name of the resource.

      • type — required — (map)

        The type of the resource.

        • cloudFormation — (map)

          The CloudFormation template of the resource type.

          • templateLocation — required — (String)

            The template location of the CloudFormation template.

          • parameters — (map<String>)

            The CloudFormation properties in the CloudFormation template.

        • m2ManagedApplication — (map)

          The AWS Mainframe Modernization managed application of the resource type.

          • applicationId — required — (String)

            The application ID of the AWS Mainframe Modernization managed application.

          • runtime — required — (String)

            The runtime of the AWS Mainframe Modernization managed application.

            Possible values include:
            • "MicroFocus"
          • vpcEndpointServiceName — (String)

            The VPC endpoint service name of the AWS Mainframe Modernization managed application.

          • listenerPort — (String)

            The listener port of the AWS Mainframe Modernization managed application.

        • m2NonManagedApplication — (map)

          The AWS Mainframe Modernization non-managed application of the resource type.

          • vpcEndpointServiceName — required — (String)

            The VPC endpoint service name of the AWS Mainframe Modernization non-managed application.

          • listenerPort — required — (String)

            The listener port of the AWS Mainframe Modernization non-managed application.

          • runtime — required — (String)

            The runtime of the AWS Mainframe Modernization non-managed application.

            Possible values include:
            • "BluAge"
          • webAppName — (String)

            The web application name of the AWS Mainframe Modernization non-managed application.

    • properties — (map<String>)

      The properties of the test configuration.

    • tags — (map<String>)

      The tags of the test configuration.

    • serviceSettings — (map)

      The service settings of the test configuration.

      • kmsKeyId — (String)

        The KMS key ID of the service settings.

Returns:

• (AWS.Request) —

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

var params = {
  stepName: 'STRING_VALUE', /* required */
  testRunId: 'STRING_VALUE', /* required */
  testCaseId: 'STRING_VALUE',
  testSuiteId: 'STRING_VALUE'
};
apptest.getTestRunStep(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: {}) —
  • testRunId — (String)

    The test run ID of the test run step.

  • stepName — (String)

    The step name of the test run step.

  • testCaseId — (String)

    The test case ID of a test run step.

  • testSuiteId — (String)

    The test suite ID of a test run step.

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:

    • stepName — (String)

      The step name of the test run step.

    • testRunId — (String)

      The test run ID of the test run step.

    • testCaseId — (String)

      The test case ID of the test run step.

    • testCaseVersion — (Integer)

      The test case version of the test run step.

    • testSuiteId — (String)

      The test suite ID of the test run step.

    • testSuiteVersion — (Integer)

      The test suite version of the test run step.

    • beforeStep — (Boolean)

      The before steps of the test run step.

    • afterStep — (Boolean)

      The after steps of the test run step.

    • status — (String)

      The status of the test run step.

      Possible values include:
      • "Success"
      • "Failed"
      • "Running"
    • statusReason — (String)

      The status reason of the test run step.

    • runStartTime — (Date)

      The run start time of the test run step.

    • runEndTime — (Date)

      The run end time of the test run step.

    • stepRunSummary — (map)

      The step run summary of the test run step.

      • mainframeAction — (map)

        The mainframe action of the step run summary.

        • batch — (map)

          The batch of the mainframe action summary.

          • stepInput — required — (map)

            The step input of the batch summary.

            • resource — required — (map)

              The resource of the batch step input.

              • m2ManagedApplication — (map)

                The AWS Mainframe Modernization managed application in the mainframe resource summary.

                • applicationId — required — (String)

                  The application ID of the AWS Mainframe Modernization managed application summary.

                • runtime — required — (String)

                  The runtime of the AWS Mainframe Modernization managed application summary.

                  Possible values include:
                  • "MicroFocus"
                • listenerPort — (Integer)

                  The listener port of the AWS Mainframe Modernization managed application summary.

              • m2NonManagedApplication — (map)

                The AWS Mainframe Modernization non-managed application in the mainframe resource summary.

                • vpcEndpointServiceName — required — (String)

                  The VPC endpoint service name of the AWS Mainframe Modernization non-managed application summary.

                • listenerPort — required — (Integer)

                  The listener port of the AWS Mainframe Modernization non-managed application summary.

                • runtime — required — (String)

                  The runtime of the AWS Mainframe Modernization non-managed application summary.

                  Possible values include:
                  • "BluAge"
                • webAppName — (String)

                  The web application name of the AWS Mainframe Modernization non-managed application summary.

            • batchJobName — required — (String)

              The batch job name of the batch step input.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch step input.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch step input.

            • properties — (map)

              The properties of the batch step input.

              • dmsTaskArn — (String)

                The DMS task ARN of the mainframe action properties.

          • stepOutput — (map)

            The step output of the batch summary.

            • dataSetExportLocation — (String)

              The data set export location of the batch step output.

            • dmsOutputLocation — (String)

              The Database Migration Service (DMS) output location of the batch step output.

            • dataSetDetails — (Array<map>)

              The data set details of the batch step output.

              • type — required — (String)

                The type of the data set.

                Possible values include:
                • "PS"
              • name — required — (String)

                The name of the data set.

              • ccsid — required — (String)

                The CCSID of the data set.

              • format — required — (String)

                The format of the data set.

                Possible values include:
                • "FIXED"
                • "VARIABLE"
                • "LINE_SEQUENTIAL"
              • length — required — (Integer)

                The length of the data set.

        • tn3270 — (map)

          The tn3270 port of the mainframe action summary.

          • stepInput — required — (map)

            The step input of the TN3270 summary.

            • resource — required — (map)

              The resource of the TN3270 step input.

              • m2ManagedApplication — (map)

                The AWS Mainframe Modernization managed application in the mainframe resource summary.

                • applicationId — required — (String)

                  The application ID of the AWS Mainframe Modernization managed application summary.

                • runtime — required — (String)

                  The runtime of the AWS Mainframe Modernization managed application summary.

                  Possible values include:
                  • "MicroFocus"
                • listenerPort — (Integer)

                  The listener port of the AWS Mainframe Modernization managed application summary.

              • m2NonManagedApplication — (map)

                The AWS Mainframe Modernization non-managed application in the mainframe resource summary.

                • vpcEndpointServiceName — required — (String)

                  The VPC endpoint service name of the AWS Mainframe Modernization non-managed application summary.

                • listenerPort — required — (Integer)

                  The listener port of the AWS Mainframe Modernization non-managed application summary.

                • runtime — required — (String)

                  The runtime of the AWS Mainframe Modernization non-managed application summary.

                  Possible values include:
                  • "BluAge"
                • webAppName — (String)

                  The web application name of the AWS Mainframe Modernization non-managed application summary.

            • script — required — (map)

              The script of the TN3270 step input.

              • scriptLocation — required — (String)

                The script location of the script summary.

              • type — required — (String)

                The type of the script summary.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The export data set names of the TN3270 step input.

            • properties — (map)

              The properties of the TN3270 step input.

              • dmsTaskArn — (String)

                The DMS task ARN of the mainframe action properties.

          • stepOutput — (map)

            The step output of the TN3270 summary.

            • dataSetExportLocation — (String)

              The data set export location of the TN3270 step output.

            • dmsOutputLocation — (String)

              The output location of the TN3270 step output.

            • dataSetDetails — (Array<map>)

              The data set details of the TN3270 step output.

              • type — required — (String)

                The type of the data set.

                Possible values include:
                • "PS"
              • name — required — (String)

                The name of the data set.

              • ccsid — required — (String)

                The CCSID of the data set.

              • format — required — (String)

                The format of the data set.

                Possible values include:
                • "FIXED"
                • "VARIABLE"
                • "LINE_SEQUENTIAL"
              • length — required — (Integer)

                The length of the data set.

            • scriptOutputLocation — required — (String)

              The script output location of the TN3270 step output.

      • compareAction — (map)

        The compare action of the step run summary.

        • type — required — (map)

          The type of the compare action summary.

          • fileType — (map)

            The file type of the file.

            • datasets — (map)

              The data sets in the compare file type.

              • stepInput — required — (map)

                The step input of the compare data sets summary.

                • sourceLocation — required — (String)

                  The source location of the compare data sets step input location.

                • targetLocation — required — (String)

                  The target location of the compare data sets step input location.

                • sourceDataSets — required — (Array<map>)

                  The source data sets of the compare data sets step input location.

                  • type — required — (String)

                    The type of the data set.

                    Possible values include:
                    • "PS"
                  • name — required — (String)

                    The name of the data set.

                  • ccsid — required — (String)

                    The CCSID of the data set.

                  • format — required — (String)

                    The format of the data set.

                    Possible values include:
                    • "FIXED"
                    • "VARIABLE"
                    • "LINE_SEQUENTIAL"
                  • length — required — (Integer)

                    The length of the data set.

                • targetDataSets — required — (Array<map>)

                  The target data sets of the compare data sets step input location.

                  • type — required — (String)

                    The type of the data set.

                    Possible values include:
                    • "PS"
                  • name — required — (String)

                    The name of the data set.

                  • ccsid — required — (String)

                    The CCSID of the data set.

                  • format — required — (String)

                    The format of the data set.

                    Possible values include:
                    • "FIXED"
                    • "VARIABLE"
                    • "LINE_SEQUENTIAL"
                  • length — required — (Integer)

                    The length of the data set.

              • stepOutput — (map)

                The step output of the compare data sets summary.

                • comparisonOutputLocation — required — (String)

                  The comparison output location of the compare data sets step output.

                • comparisonStatus — required — (String)

                  The comparison status of the compare data sets step output.

                  Possible values include:
                  • "Different"
                  • "Equivalent"
                  • "Equal"
            • databaseCDC — (map)

              The database CDC of the compare file type.

              • stepInput — required — (map)

                The step input of the compare database CDC summary.

                • sourceLocation — required — (String)

                  The source location of the compare database CDC step input.

                • targetLocation — required — (String)

                  The target location of the compare database CDC step input.

                • outputLocation — (String)

                  The output location of the compare database CDC step input.

                • sourceMetadata — required — (map)

                  The source metadata of the compare database CDC step input.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata location of the compare database CDC step input.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
              • stepOutput — (map)

                The step output of the compare database CDC summary.

                • comparisonOutputLocation — required — (String)

                  The comparison output of the compare database CDC step output.

                • comparisonStatus — required — (String)

                  The comparison status of the compare database CDC step output.

                  Possible values include:
                  • "Different"
                  • "Equivalent"
                  • "Equal"
      • resourceAction — (map)

        The resource action of the step run summary.

        • cloudFormation — (map)

          The CloudFormation template of the resource action summary.

          • createCloudformation — (map)

            Creates the CloudFormation summary of the step.

            • stepInput — required — (map)

              The step input of the CloudFormation summary.

              • templateLocation — required — (String)

                The template location of the CloudFormation step input.

              • parameters — (map<String>)

                The CloudFormation properties of the CloudFormation step input.

            • stepOutput — (map)

              The step output of the CloudFormation summary.

              • stackId — required — (String)

                The stack ID of the CloudFormation step output.

              • exports — (map<String>)

                The exports of the CloudFormation step output.

          • deleteCloudformation — (map)

            Deletes the CloudFormation summary of the CloudFormation step summary.

            • stepInput — required — (map)

              The step input of the deleted CloudFormation summary.

              • stackId — required — (String)

                The stack ID of the deleted CloudFormation step input.

            • stepOutput — (map)

              The step output of the deleted CloudFormation summary.

        • m2ManagedApplication — (map)

          The AWS Mainframe Modernization managed application of the resource action summary.

          • stepInput — required — (map)

            The step input of the AWS Mainframe Modernization managed application step summary.

            • applicationId — required — (String)

              The application ID of the AWS Mainframe Modernization managed application step input.

            • runtime — required — (String)

              The runtime of the AWS Mainframe Modernization managed application step input.

            • vpcEndpointServiceName — (String)

              The VPC endpoint service name of the AWS Mainframe Modernization managed application step input.

            • listenerPort — (Integer)

              The listener port of the AWS Mainframe Modernization managed application step input.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization managed application step input.

              Possible values include:
              • "Configure"
              • "Deconfigure"
            • properties — (map)

              The properties of the AWS Mainframe Modernization managed application step input.

              • forceStop — (Boolean)

                Force stops the AWS Mainframe Modernization managed action properties.

              • importDataSetLocation — (String)

                The import data set location of the AWS Mainframe Modernization managed action properties.

          • stepOutput — (map)

            The step output of the AWS Mainframe Modernization managed application step summary.

            • importDataSetSummary — (map<String>)

              The import data set summary of the AWS Mainframe Modernization managed application step output.

        • m2NonManagedApplication — (map)

          The AWS Mainframe Modernization non-managed application of the resource action summary.

          • stepInput — required — (map)

            The step input of the AWS Mainframe Modernization non-managed application step summary.

            • vpcEndpointServiceName — required — (String)

              The VPC endpoint service name of the AWS Mainframe Modernization non-managed application step input.

            • listenerPort — required — (Integer)

              The listener port of the AWS Mainframe Modernization non-managed application step input.

            • runtime — required — (String)

              The runtime of the AWS Mainframe Modernization non-managed application step input.

              Possible values include:
              • "BluAge"
            • webAppName — (String)

              The web app name of the AWS Mainframe Modernization non-managed application step input.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization non-managed application step input.

              Possible values include:
              • "Configure"
              • "Deconfigure"
          • stepOutput — (map)

            The step output of the AWS Mainframe Modernization non-managed application step summary.

Returns:

• (AWS.Request) —

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

var params = {
  testSuiteId: 'STRING_VALUE', /* required */
  testSuiteVersion: 'NUMBER_VALUE'
};
apptest.getTestSuite(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: {}) —
  • testSuiteId — (String)

    The ID of the test suite.

  • testSuiteVersion — (Integer)

    The version of the test suite.

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:

    • testSuiteId — (String)

      The response ID of the test suite.

    • name — (String)

      The name of the test suite.

    • latestVersion — (map)

      The latest version of the test suite.

      • version — required — (Integer)

        The version of the test suite latest version.

      • status — required — (String)

        The status of the test suite latest version.

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

        The status reason of the test suite latest version.

    • testSuiteVersion — (Integer)

      The version of the test suite.

    • status — (String)

      The status of the test suite.

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

      The status reason of the test suite.

    • testSuiteArn — (String)

      The test suite Amazon Resource Name (ARN).

    • creationTime — (Date)

      The creation time of the test suite.

    • lastUpdateTime — (Date)

      The last update time of the test suite.

    • description — (String)

      The description of the test suite.

    • beforeSteps — (Array<map>)

      The before steps of the test suite.

      • name — required — (String)

        The name of the step.

      • description — (String)

        The description of the step.

      • action — required — (map)

        The action of the step.

        • resourceAction — (map)

          The resource action of the step action.

          • m2ManagedApplicationAction — (map)

            The AWS Mainframe Modernization managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
            • properties — (map)

              The properties of the AWS Mainframe Modernization managed application action.

              • forceStop — (Boolean)

                Force stops the AWS Mainframe Modernization managed action properties.

              • importDataSetLocation — (String)

                The import data set location of the AWS Mainframe Modernization managed action properties.

          • m2NonManagedApplicationAction — (map)

            The AWS Mainframe Modernization non-managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization non-managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization non-managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
          • cloudFormationAction — (map)

            The CloudFormation action of the resource action.

            • resource — required — (String)

              The resource of the CloudFormation action.

            • actionType — (String)

              The action type of the CloudFormation action.

              Possible values include:
              • "Create"
              • "Delete"
        • mainframeAction — (map)

          The mainframe action of the step action.

          • resource — required — (String)

            The resource of the mainframe action.

          • actionType — required — (map)

            The action type of the mainframe action.

            • batch — (map)

              The batch of the mainframe action type.

              • batchJobName — required — (String)

                The job name of the batch.

              • batchJobParameters — (map<String>)

                The batch job parameters of the batch.

              • exportDataSetNames — (Array<String>)

                The export data set names of the batch.

            • tn3270 — (map)

              The tn3270 port of the mainframe action type.

              • script — required — (map)

                The script of the TN3270 protocol.

                • scriptLocation — required — (String)

                  The script location of the scripts.

                • type — required — (String)

                  The type of the scripts.

                  Possible values include:
                  • "Selenium"
              • exportDataSetNames — (Array<String>)

                The data set names of the TN3270 protocol.

          • properties — (map)

            The properties of the mainframe action.

            • dmsTaskArn — (String)

              The DMS task ARN of the mainframe action properties.

        • compareAction — (map)

          The compare action of the step action.

          • input — required — (map)

            The input of the compare action.

            • file — (map)

              The file in the input.

              • sourceLocation — required — (String)

                The source location of the input file.

              • targetLocation — required — (String)

                The target location of the input file.

              • fileMetadata — required — (map)

                The file metadata of the input file.

                • dataSets — (Array<map>)

                  The data sets of the file metadata.

                  • type — required — (String)

                    The type of the data set.

                    Possible values include:
                    • "PS"
                  • name — required — (String)

                    The name of the data set.

                  • ccsid — required — (String)

                    The CCSID of the data set.

                  • format — required — (String)

                    The format of the data set.

                    Possible values include:
                    • "FIXED"
                    • "VARIABLE"
                    • "LINE_SEQUENTIAL"
                  • length — required — (Integer)

                    The length of the data set.

                • databaseCDC — (map)

                  The database CDC of the file metadata.

                  • sourceMetadata — required — (map)

                    The source metadata of the database CDC.

                    • type — required — (String)

                      The type of the source database metadata.

                      Possible values include:
                      • "z/OS-DB2"
                    • captureTool — required — (String)

                      The capture tool of the source database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
                  • targetMetadata — required — (map)

                    The target metadata of the database CDC.

                    • type — required — (String)

                      The type of the target database metadata.

                      Possible values include:
                      • "PostgreSQL"
                    • captureTool — required — (String)

                      The capture tool of the target database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
          • output — (map)

            The output of the compare action.

            • file — (map)

              The file of the output.

              • fileLocation — (String)

                The file location of the output file.

    • afterSteps — (Array<map>)

      The after steps of the test suite.

      • name — required — (String)

        The name of the step.

      • description — (String)

        The description of the step.

      • action — required — (map)

        The action of the step.

        • resourceAction — (map)

          The resource action of the step action.

          • m2ManagedApplicationAction — (map)

            The AWS Mainframe Modernization managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
            • properties — (map)

              The properties of the AWS Mainframe Modernization managed application action.

              • forceStop — (Boolean)

                Force stops the AWS Mainframe Modernization managed action properties.

              • importDataSetLocation — (String)

                The import data set location of the AWS Mainframe Modernization managed action properties.

          • m2NonManagedApplicationAction — (map)

            The AWS Mainframe Modernization non-managed application action of the resource action.

            • resource — required — (String)

              The resource of the AWS Mainframe Modernization non-managed application action.

            • actionType — required — (String)

              The action type of the AWS Mainframe Modernization non-managed application action.

              Possible values include:
              • "Configure"
              • "Deconfigure"
          • cloudFormationAction — (map)

            The CloudFormation action of the resource action.

            • resource — required — (String)

              The resource of the CloudFormation action.

            • actionType — (String)

              The action type of the CloudFormation action.

              Possible values include:
              • "Create"
              • "Delete"
        • mainframeAction — (map)

          The mainframe action of the step action.

          • resource — required — (String)

            The resource of the mainframe action.

          • actionType — required — (map)

            The action type of the mainframe action.

            • batch — (map)

              The batch of the mainframe action type.

              • batchJobName — required — (String)

                The job name of the batch.

              • batchJobParameters — (map<String>)

                The batch job parameters of the batch.

              • exportDataSetNames — (Array<String>)

                The export data set names of the batch.

            • tn3270 — (map)

              The tn3270 port of the mainframe action type.

              • script — required — (map)

                The script of the TN3270 protocol.

                • scriptLocation — required — (String)

                  The script location of the scripts.

                • type — required — (String)

                  The type of the scripts.

                  Possible values include:
                  • "Selenium"
              • exportDataSetNames — (Array<String>)

                The data set names of the TN3270 protocol.

          • properties — (map)

            The properties of the mainframe action.

            • dmsTaskArn — (String)

              The DMS task ARN of the mainframe action properties.

        • compareAction — (map)

          The compare action of the step action.

          • input — required — (map)

            The input of the compare action.

            • file — (map)

              The file in the input.

              • sourceLocation — required — (String)

                The source location of the input file.

              • targetLocation — required — (String)

                The target location of the input file.

              • fileMetadata — required — (map)

                The file metadata of the input file.

                • dataSets — (Array<map>)

                  The data sets of the file metadata.

                  • type — required — (String)

                    The type of the data set.

                    Possible values include:
                    • "PS"
                  • name — required — (String)

                    The name of the data set.

                  • ccsid — required — (String)

                    The CCSID of the data set.

                  • format — required — (String)

                    The format of the data set.

                    Possible values include:
                    • "FIXED"
                    • "VARIABLE"
                    • "LINE_SEQUENTIAL"
                  • length — required — (Integer)

                    The length of the data set.

                • databaseCDC — (map)

                  The database CDC of the file metadata.

                  • sourceMetadata — required — (map)

                    The source metadata of the database CDC.

                    • type — required — (String)

                      The type of the source database metadata.

                      Possible values include:
                      • "z/OS-DB2"
                    • captureTool — required — (String)

                      The capture tool of the source database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
                  • targetMetadata — required — (map)

                    The target metadata of the database CDC.

                    • type — required — (String)

                      The type of the target database metadata.

                      Possible values include:
                      • "PostgreSQL"
                    • captureTool — required — (String)

                      The capture tool of the target database metadata.

                      Possible values include:
                      • "Precisely"
                      • "AWS DMS"
          • output — (map)

            The output of the compare action.

            • file — (map)

              The file of the output.

              • fileLocation — (String)

                The file location of the output file.

    • testCases — (map)

      The test cases of the test suite.

      • sequential — (Array<String>)

        The sequential of the test case.

    • tags — (map<String>)

      The tags of the test suite.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
apptest.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 of the resource.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  testCaseIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
apptest.listTestCases(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: {}) —
  • testCaseIds — (Array<String>)

    The IDs of the test cases.

  • nextToken — (String)

    The next token of the test cases.

  • maxResults — (Integer)

    The maximum results of the test case.

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:

    • testCases — (Array<map>)

      The test cases in an application.

      • testCaseId — required — (String)

        The test case ID of the test case summary.

      • testCaseArn — required — (String)

        The test case Amazon Resource Name (ARN) of the test case summary.

      • name — required — (String)

        The name of the test case summary.

      • statusReason — (String)

        The status reason of the test case summary.

      • latestVersion — required — (Integer)

        The latest version of the test case summary.

      • status — required — (String)

        The status of the test case summary.

        Possible values include:
        • "Active"
        • "Deleting"
      • creationTime — required — (Date)

        The creation time of the test case summary.

      • lastUpdateTime — required — (Date)

        The last update time of the test case summary.

    • nextToken — (String)

      The next token in test cases.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  testConfigurationIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
apptest.listTestConfigurations(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: {}) —
  • testConfigurationIds — (Array<String>)

    The configuration IDs of the test configurations.

  • nextToken — (String)

    The next token for the test configurations.

  • maxResults — (Integer)

    The maximum results of the test configuration.

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:

    • testConfigurations — (Array<map>)

      The test configurations.

      • testConfigurationId — required — (String)

        The test configuration ID of the test configuration summary.

      • name — required — (String)

        The name of the test configuration summary.

      • statusReason — (String)

        The status reason of the test configuration summary.

      • latestVersion — required — (Integer)

        The latest version of the test configuration summary.

      • testConfigurationArn — required — (String)

        The test configuration ARN of the test configuration summary.

      • status — required — (String)

        The status of the test configuration summary.

        Possible values include:
        • "Active"
        • "Deleting"
      • creationTime — required — (Date)

        The creation time of the test configuration summary.

      • lastUpdateTime — required — (Date)

        The last update time of the test configuration summary.

    • nextToken — (String)

      The next token in the test configurations.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  testRunIds: [
    'STRING_VALUE',
    /* more items */
  ],
  testSuiteId: 'STRING_VALUE'
};
apptest.listTestRuns(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: {}) —
  • testSuiteId — (String)

    The test suite ID of the test runs.

  • testRunIds — (Array<String>)

    The test run IDs of the test runs.

  • nextToken — (String)

    The token from the previous request to retrieve the next page of test run results.

  • maxResults — (Integer)

    The maximum number of test runs to return in one page of results.

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:

    • testRuns — (Array<map>)

      The test runs of the response query.

      • testRunId — required — (String)

        The test run ID of the test run summary.

      • testRunArn — required — (String)

        The test run ARN of the test run summary.

      • testSuiteId — required — (String)

        The test suite ID of the test run summary.

      • testSuiteVersion — required — (Integer)

        The test suite version of the test run summary.

      • testConfigurationId — (String)

        The test configuration ID of the test run summary.

      • testConfigurationVersion — (Integer)

        The test configuration version of the test run summary.

      • status — required — (String)

        The status of the test run summary.

        Possible values include:
        • "Success"
        • "Running"
        • "Failed"
        • "Deleting"
      • statusReason — (String)

        The status reason of the test run summary.

      • runStartTime — required — (Date)

        The run start time of the test run summary.

      • runEndTime — (Date)

        The run end time of the test run summary.

    • nextToken — (String)

      The token from the previous request to retrieve the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  testRunId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  testCaseId: 'STRING_VALUE',
  testSuiteId: 'STRING_VALUE'
};
apptest.listTestRunSteps(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: {}) —
  • testRunId — (String)

    The test run ID of the test run steps.

  • testCaseId — (String)

    The test case ID of the test run steps.

  • testSuiteId — (String)

    The test suite ID of the test run steps.

  • nextToken — (String)

    The token from a previous step to retrieve the next page of results.

  • maxResults — (Integer)

    The maximum number of test run steps to return in one page of results.

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:

    • testRunSteps — (Array<map>)

      The test run steps of the response query.

      • stepName — required — (String)

        The step name of the test run step summary.

      • testRunId — required — (String)

        The test run ID of the test run step summary.

      • testCaseId — (String)

        The test case ID of the test run step summary.

      • testCaseVersion — (Integer)

        The test case version of the test run step summary.

      • testSuiteId — (String)

        The test suite ID of the test run step summary.

      • testSuiteVersion — (Integer)

        The test suite version of the test run step summary.

      • beforeStep — (Boolean)

        The before step of the test run step summary.

      • afterStep — (Boolean)

        The after step of the test run step summary.

      • status — required — (String)

        The status of the test run step summary.

        Possible values include:
        • "Success"
        • "Failed"
        • "Running"
      • statusReason — (String)

        The status reason of the test run step summary.

      • runStartTime — required — (Date)

        The run start time of the test run step summary.

      • runEndTime — (Date)

        The run end time of the test run step summary.

    • nextToken — (String)

      The token from a previous request to retrieve the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  testRunId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
apptest.listTestRunTestCases(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: {}) —
  • testRunId — (String)

    The test run ID of the test cases.

  • nextToken — (String)

    The token from a previous request to retrieve the next page of results.

  • maxResults — (Integer)

    The maximum number of test run test cases to return in one page of results.

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:

    • testRunTestCases — (Array<map>)

      The test run of the test cases.

      • testCaseId — required — (String)

        The test case id of the test case run summary.

      • testCaseVersion — required — (Integer)

        The test case version of the test case run summary.

      • testRunId — required — (String)

        The test run id of the test case run summary.

      • status — required — (String)

        The status of the test case run summary.

        Possible values include:
        • "Success"
        • "Running"
        • "Failed"
      • statusReason — (String)

        The status reason of the test case run summary.

      • runStartTime — required — (Date)

        The run start time of the test case run summary.

      • runEndTime — (Date)

        The run end time of the test case run summary.

    • nextToken — (String)

      The token from a previous request to retrieve the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  testSuiteIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
apptest.listTestSuites(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: {}) —
  • testSuiteIds — (Array<String>)

    The suite ID of the test suites.

  • nextToken — (String)

    The token from a previous request to retrieve the next page of results.

  • maxResults — (Integer)

    The maximum number of test suites to return in one page of results.

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:

    • testSuites — (Array<map>)

      The test suites returned with the response query.

      • testSuiteId — required — (String)

        The test suite ID of the test suite summary.

      • name — required — (String)

        The name of the test suite summary.

      • statusReason — (String)

        The status reason of the test suite summary.

      • latestVersion — required — (Integer)

        The latest version of the test suite summary.

      • testSuiteArn — required — (String)

        The test suite Amazon Resource Name (ARN) of the test suite summary.

      • status — required — (String)

        The status of the test suite summary.

        Possible values include:
        • "Creating"
        • "Updating"
        • "Active"
        • "Failed"
        • "Deleting"
      • creationTime — required — (Date)

        The creation time of the test suite summary.

      • lastUpdateTime — required — (Date)

        The last update time of the test suite summary.

    • nextToken — (String)

      The token from a previous request to retrieve the next page of test suites results.

Returns:

• (AWS.Request) —

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

var params = {
  testSuiteId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  testConfigurationId: 'STRING_VALUE'
};
apptest.startTestRun(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: {}) —
  • testSuiteId — (String)

    The test suite ID of the test run.

  • testConfigurationId — (String)

    The configuration ID of the test run.

  • clientToken — (String)

    The client token of the test run.

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

    The tags of the test run.

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:

    • testRunId — (String)

      The test run ID of the test run.

    • testRunStatus — (String)

      The test run status of the test run.

      Possible values include:
      • "Success"
      • "Running"
      • "Failed"
      • "Deleting"

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
apptest.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 tag resource.

  • tags — (map<String>)

    The tags 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.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
apptest.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 tag keys 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.

Returns:

• (AWS.Request) —

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

var params = {
  testCaseId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  steps: [
    {
      action: { /* required */
        compareAction: {
          input: { /* required */
            file: {
              fileMetadata: { /* required */
                dataSets: [
                  {
                    ccsid: 'STRING_VALUE', /* required */
                    format: FIXED | VARIABLE | LINE_SEQUENTIAL, /* required */
                    length: 'NUMBER_VALUE', /* required */
                    name: 'STRING_VALUE', /* required */
                    type: PS /* required */
                  },
                  /* more items */
                ],
                databaseCDC: {
                  sourceMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: z/OS-DB2 /* required */
                  },
                  targetMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: PostgreSQL /* required */
                  }
                }
              },
              sourceLocation: 'STRING_VALUE', /* required */
              targetLocation: 'STRING_VALUE' /* required */
            }
          },
          output: {
            file: {
              fileLocation: 'STRING_VALUE'
            }
          }
        },
        mainframeAction: {
          actionType: { /* required */
            batch: {
              batchJobName: 'STRING_VALUE', /* required */
              batchJobParameters: {
                '<String>': 'STRING_VALUE',
                /* '<String>': ... */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tn3270: {
              script: { /* required */
                scriptLocation: 'STRING_VALUE', /* required */
                type: Selenium /* required */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          resource: 'STRING_VALUE', /* required */
          properties: {
            dmsTaskArn: 'STRING_VALUE'
          }
        },
        resourceAction: {
          cloudFormationAction: {
            resource: 'STRING_VALUE', /* required */
            actionType: Create | Delete
          },
          m2ManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE', /* required */
            properties: {
              forceStop: true || false,
              importDataSetLocation: 'STRING_VALUE'
            }
          },
          m2NonManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE' /* required */
          }
        }
      },
      name: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apptest.updateTestCase(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: {}) —
  • testCaseId — (String)

    The test case ID of the test case.

  • description — (String)

    The description of the test case.

  • steps — (Array<map>)

    The steps of the test case.

    • name — required — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • action — required — (map)

      The action of the step.

      • resourceAction — (map)

        The resource action of the step action.

        • m2ManagedApplicationAction — (map)

          The AWS Mainframe Modernization managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
          • properties — (map)

            The properties of the AWS Mainframe Modernization managed application action.

            • forceStop — (Boolean)

              Force stops the AWS Mainframe Modernization managed action properties.

            • importDataSetLocation — (String)

              The import data set location of the AWS Mainframe Modernization managed action properties.

        • m2NonManagedApplicationAction — (map)

          The AWS Mainframe Modernization non-managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization non-managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization non-managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
        • cloudFormationAction — (map)

          The CloudFormation action of the resource action.

          • resource — required — (String)

            The resource of the CloudFormation action.

          • actionType — (String)

            The action type of the CloudFormation action.

            Possible values include:
            • "Create"
            • "Delete"
      • mainframeAction — (map)

        The mainframe action of the step action.

        • resource — required — (String)

          The resource of the mainframe action.

        • actionType — required — (map)

          The action type of the mainframe action.

          • batch — (map)

            The batch of the mainframe action type.

            • batchJobName — required — (String)

              The job name of the batch.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch.

          • tn3270 — (map)

            The tn3270 port of the mainframe action type.

            • script — required — (map)

              The script of the TN3270 protocol.

              • scriptLocation — required — (String)

                The script location of the scripts.

              • type — required — (String)

                The type of the scripts.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The data set names of the TN3270 protocol.

        • properties — (map)

          The properties of the mainframe action.

          • dmsTaskArn — (String)

            The DMS task ARN of the mainframe action properties.

      • compareAction — (map)

        The compare action of the step action.

        • input — required — (map)

          The input of the compare action.

          • file — (map)

            The file in the input.

            • sourceLocation — required — (String)

              The source location of the input file.

            • targetLocation — required — (String)

              The target location of the input file.

            • fileMetadata — required — (map)

              The file metadata of the input file.

              • dataSets — (Array<map>)

                The data sets of the file metadata.

                • type — required — (String)

                  The type of the data set.

                  Possible values include:
                  • "PS"
                • name — required — (String)

                  The name of the data set.

                • ccsid — required — (String)

                  The CCSID of the data set.

                • format — required — (String)

                  The format of the data set.

                  Possible values include:
                  • "FIXED"
                  • "VARIABLE"
                  • "LINE_SEQUENTIAL"
                • length — required — (Integer)

                  The length of the data set.

              • databaseCDC — (map)

                The database CDC of the file metadata.

                • sourceMetadata — required — (map)

                  The source metadata of the database CDC.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata of the database CDC.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
        • output — (map)

          The output of the compare action.

          • file — (map)

            The file of the output.

            • fileLocation — (String)

              The file location of the output file.

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:

    • testCaseId — (String)

      The test case ID of the test case.

    • testCaseVersion — (Integer)

      The test case version of the test case.

Returns:

• (AWS.Request) —

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

var params = {
  testConfigurationId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  properties: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  resources: [
    {
      name: 'STRING_VALUE', /* required */
      type: { /* required */
        cloudFormation: {
          templateLocation: 'STRING_VALUE', /* required */
          parameters: {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          }
        },
        m2ManagedApplication: {
          applicationId: 'STRING_VALUE', /* required */
          runtime: MicroFocus, /* required */
          listenerPort: 'STRING_VALUE',
          vpcEndpointServiceName: 'STRING_VALUE'
        },
        m2NonManagedApplication: {
          listenerPort: 'STRING_VALUE', /* required */
          runtime: BluAge, /* required */
          vpcEndpointServiceName: 'STRING_VALUE', /* required */
          webAppName: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ],
  serviceSettings: {
    kmsKeyId: 'STRING_VALUE'
  }
};
apptest.updateTestConfiguration(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: {}) —
  • testConfigurationId — (String)

    The test configuration ID of the test configuration.

  • description — (String)

    The description of the test configuration.

  • resources — (Array<map>)

    The resources of the test configuration.

    • name — required — (String)

      The name of the resource.

    • type — required — (map)

      The type of the resource.

      • cloudFormation — (map)

        The CloudFormation template of the resource type.

        • templateLocation — required — (String)

          The template location of the CloudFormation template.

        • parameters — (map<String>)

          The CloudFormation properties in the CloudFormation template.

      • m2ManagedApplication — (map)

        The AWS Mainframe Modernization managed application of the resource type.

        • applicationId — required — (String)

          The application ID of the AWS Mainframe Modernization managed application.

        • runtime — required — (String)

          The runtime of the AWS Mainframe Modernization managed application.

          Possible values include:
          • "MicroFocus"
        • vpcEndpointServiceName — (String)

          The VPC endpoint service name of the AWS Mainframe Modernization managed application.

        • listenerPort — (String)

          The listener port of the AWS Mainframe Modernization managed application.

      • m2NonManagedApplication — (map)

        The AWS Mainframe Modernization non-managed application of the resource type.

        • vpcEndpointServiceName — required — (String)

          The VPC endpoint service name of the AWS Mainframe Modernization non-managed application.

        • listenerPort — required — (String)

          The listener port of the AWS Mainframe Modernization non-managed application.

        • runtime — required — (String)

          The runtime of the AWS Mainframe Modernization non-managed application.

          Possible values include:
          • "BluAge"
        • webAppName — (String)

          The web application name of the AWS Mainframe Modernization non-managed application.

  • properties — (map<String>)

    The properties of the test configuration.

  • serviceSettings — (map)

    The service settings of the test configuration.

    • kmsKeyId — (String)

      The KMS key ID of the service settings.

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:

    • testConfigurationId — (String)

      The configuration ID of the test configuration.

    • testConfigurationVersion — (Integer)

      The configuration version of the test configuration.

Returns:

• (AWS.Request) —

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

var params = {
  testSuiteId: 'STRING_VALUE', /* required */
  afterSteps: [
    {
      action: { /* required */
        compareAction: {
          input: { /* required */
            file: {
              fileMetadata: { /* required */
                dataSets: [
                  {
                    ccsid: 'STRING_VALUE', /* required */
                    format: FIXED | VARIABLE | LINE_SEQUENTIAL, /* required */
                    length: 'NUMBER_VALUE', /* required */
                    name: 'STRING_VALUE', /* required */
                    type: PS /* required */
                  },
                  /* more items */
                ],
                databaseCDC: {
                  sourceMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: z/OS-DB2 /* required */
                  },
                  targetMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: PostgreSQL /* required */
                  }
                }
              },
              sourceLocation: 'STRING_VALUE', /* required */
              targetLocation: 'STRING_VALUE' /* required */
            }
          },
          output: {
            file: {
              fileLocation: 'STRING_VALUE'
            }
          }
        },
        mainframeAction: {
          actionType: { /* required */
            batch: {
              batchJobName: 'STRING_VALUE', /* required */
              batchJobParameters: {
                '<String>': 'STRING_VALUE',
                /* '<String>': ... */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tn3270: {
              script: { /* required */
                scriptLocation: 'STRING_VALUE', /* required */
                type: Selenium /* required */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          resource: 'STRING_VALUE', /* required */
          properties: {
            dmsTaskArn: 'STRING_VALUE'
          }
        },
        resourceAction: {
          cloudFormationAction: {
            resource: 'STRING_VALUE', /* required */
            actionType: Create | Delete
          },
          m2ManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE', /* required */
            properties: {
              forceStop: true || false,
              importDataSetLocation: 'STRING_VALUE'
            }
          },
          m2NonManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE' /* required */
          }
        }
      },
      name: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  beforeSteps: [
    {
      action: { /* required */
        compareAction: {
          input: { /* required */
            file: {
              fileMetadata: { /* required */
                dataSets: [
                  {
                    ccsid: 'STRING_VALUE', /* required */
                    format: FIXED | VARIABLE | LINE_SEQUENTIAL, /* required */
                    length: 'NUMBER_VALUE', /* required */
                    name: 'STRING_VALUE', /* required */
                    type: PS /* required */
                  },
                  /* more items */
                ],
                databaseCDC: {
                  sourceMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: z/OS-DB2 /* required */
                  },
                  targetMetadata: { /* required */
                    captureTool: Precisely | AWS DMS, /* required */
                    type: PostgreSQL /* required */
                  }
                }
              },
              sourceLocation: 'STRING_VALUE', /* required */
              targetLocation: 'STRING_VALUE' /* required */
            }
          },
          output: {
            file: {
              fileLocation: 'STRING_VALUE'
            }
          }
        },
        mainframeAction: {
          actionType: { /* required */
            batch: {
              batchJobName: 'STRING_VALUE', /* required */
              batchJobParameters: {
                '<String>': 'STRING_VALUE',
                /* '<String>': ... */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tn3270: {
              script: { /* required */
                scriptLocation: 'STRING_VALUE', /* required */
                type: Selenium /* required */
              },
              exportDataSetNames: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          resource: 'STRING_VALUE', /* required */
          properties: {
            dmsTaskArn: 'STRING_VALUE'
          }
        },
        resourceAction: {
          cloudFormationAction: {
            resource: 'STRING_VALUE', /* required */
            actionType: Create | Delete
          },
          m2ManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE', /* required */
            properties: {
              forceStop: true || false,
              importDataSetLocation: 'STRING_VALUE'
            }
          },
          m2NonManagedApplicationAction: {
            actionType: Configure | Deconfigure, /* required */
            resource: 'STRING_VALUE' /* required */
          }
        }
      },
      name: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  testCases: {
    sequential: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
apptest.updateTestSuite(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: {}) —
  • testSuiteId — (String)

    The test suite ID of the test suite.

  • description — (String)

    The description of the test suite.

  • beforeSteps — (Array<map>)

    The before steps for the test suite.

    • name — required — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • action — required — (map)

      The action of the step.

      • resourceAction — (map)

        The resource action of the step action.

        • m2ManagedApplicationAction — (map)

          The AWS Mainframe Modernization managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
          • properties — (map)

            The properties of the AWS Mainframe Modernization managed application action.

            • forceStop — (Boolean)

              Force stops the AWS Mainframe Modernization managed action properties.

            • importDataSetLocation — (String)

              The import data set location of the AWS Mainframe Modernization managed action properties.

        • m2NonManagedApplicationAction — (map)

          The AWS Mainframe Modernization non-managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization non-managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization non-managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
        • cloudFormationAction — (map)

          The CloudFormation action of the resource action.

          • resource — required — (String)

            The resource of the CloudFormation action.

          • actionType — (String)

            The action type of the CloudFormation action.

            Possible values include:
            • "Create"
            • "Delete"
      • mainframeAction — (map)

        The mainframe action of the step action.

        • resource — required — (String)

          The resource of the mainframe action.

        • actionType — required — (map)

          The action type of the mainframe action.

          • batch — (map)

            The batch of the mainframe action type.

            • batchJobName — required — (String)

              The job name of the batch.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch.

          • tn3270 — (map)

            The tn3270 port of the mainframe action type.

            • script — required — (map)

              The script of the TN3270 protocol.

              • scriptLocation — required — (String)

                The script location of the scripts.

              • type — required — (String)

                The type of the scripts.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The data set names of the TN3270 protocol.

        • properties — (map)

          The properties of the mainframe action.

          • dmsTaskArn — (String)

            The DMS task ARN of the mainframe action properties.

      • compareAction — (map)

        The compare action of the step action.

        • input — required — (map)

          The input of the compare action.

          • file — (map)

            The file in the input.

            • sourceLocation — required — (String)

              The source location of the input file.

            • targetLocation — required — (String)

              The target location of the input file.

            • fileMetadata — required — (map)

              The file metadata of the input file.

              • dataSets — (Array<map>)

                The data sets of the file metadata.

                • type — required — (String)

                  The type of the data set.

                  Possible values include:
                  • "PS"
                • name — required — (String)

                  The name of the data set.

                • ccsid — required — (String)

                  The CCSID of the data set.

                • format — required — (String)

                  The format of the data set.

                  Possible values include:
                  • "FIXED"
                  • "VARIABLE"
                  • "LINE_SEQUENTIAL"
                • length — required — (Integer)

                  The length of the data set.

              • databaseCDC — (map)

                The database CDC of the file metadata.

                • sourceMetadata — required — (map)

                  The source metadata of the database CDC.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata of the database CDC.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
        • output — (map)

          The output of the compare action.

          • file — (map)

            The file of the output.

            • fileLocation — (String)

              The file location of the output file.

  • afterSteps — (Array<map>)

    The after steps of the test suite.

    • name — required — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • action — required — (map)

      The action of the step.

      • resourceAction — (map)

        The resource action of the step action.

        • m2ManagedApplicationAction — (map)

          The AWS Mainframe Modernization managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
          • properties — (map)

            The properties of the AWS Mainframe Modernization managed application action.

            • forceStop — (Boolean)

              Force stops the AWS Mainframe Modernization managed action properties.

            • importDataSetLocation — (String)

              The import data set location of the AWS Mainframe Modernization managed action properties.

        • m2NonManagedApplicationAction — (map)

          The AWS Mainframe Modernization non-managed application action of the resource action.

          • resource — required — (String)

            The resource of the AWS Mainframe Modernization non-managed application action.

          • actionType — required — (String)

            The action type of the AWS Mainframe Modernization non-managed application action.

            Possible values include:
            • "Configure"
            • "Deconfigure"
        • cloudFormationAction — (map)

          The CloudFormation action of the resource action.

          • resource — required — (String)

            The resource of the CloudFormation action.

          • actionType — (String)

            The action type of the CloudFormation action.

            Possible values include:
            • "Create"
            • "Delete"
      • mainframeAction — (map)

        The mainframe action of the step action.

        • resource — required — (String)

          The resource of the mainframe action.

        • actionType — required — (map)

          The action type of the mainframe action.

          • batch — (map)

            The batch of the mainframe action type.

            • batchJobName — required — (String)

              The job name of the batch.

            • batchJobParameters — (map<String>)

              The batch job parameters of the batch.

            • exportDataSetNames — (Array<String>)

              The export data set names of the batch.

          • tn3270 — (map)

            The tn3270 port of the mainframe action type.

            • script — required — (map)

              The script of the TN3270 protocol.

              • scriptLocation — required — (String)

                The script location of the scripts.

              • type — required — (String)

                The type of the scripts.

                Possible values include:
                • "Selenium"
            • exportDataSetNames — (Array<String>)

              The data set names of the TN3270 protocol.

        • properties — (map)

          The properties of the mainframe action.

          • dmsTaskArn — (String)

            The DMS task ARN of the mainframe action properties.

      • compareAction — (map)

        The compare action of the step action.

        • input — required — (map)

          The input of the compare action.

          • file — (map)

            The file in the input.

            • sourceLocation — required — (String)

              The source location of the input file.

            • targetLocation — required — (String)

              The target location of the input file.

            • fileMetadata — required — (map)

              The file metadata of the input file.

              • dataSets — (Array<map>)

                The data sets of the file metadata.

                • type — required — (String)

                  The type of the data set.

                  Possible values include:
                  • "PS"
                • name — required — (String)

                  The name of the data set.

                • ccsid — required — (String)

                  The CCSID of the data set.

                • format — required — (String)

                  The format of the data set.

                  Possible values include:
                  • "FIXED"
                  • "VARIABLE"
                  • "LINE_SEQUENTIAL"
                • length — required — (Integer)

                  The length of the data set.

              • databaseCDC — (map)

                The database CDC of the file metadata.

                • sourceMetadata — required — (map)

                  The source metadata of the database CDC.

                  • type — required — (String)

                    The type of the source database metadata.

                    Possible values include:
                    • "z/OS-DB2"
                  • captureTool — required — (String)

                    The capture tool of the source database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
                • targetMetadata — required — (map)

                  The target metadata of the database CDC.

                  • type — required — (String)

                    The type of the target database metadata.

                    Possible values include:
                    • "PostgreSQL"
                  • captureTool — required — (String)

                    The capture tool of the target database metadata.

                    Possible values include:
                    • "Precisely"
                    • "AWS DMS"
        • output — (map)

          The output of the compare action.

          • file — (map)

            The file of the output.

            • fileLocation — (String)

              The file location of the output file.

  • testCases — (map)

    The test cases in the test suite.

    • sequential — (Array<String>)

      The sequential of the test case.

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:

    • testSuiteId — (String)

      The test suite ID of the test suite.

    • testSuiteVersion — (Integer)

      The test suite version of the test suite.

Returns:

• (AWS.Request) —

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

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

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