AWS Mainframe Modernization Application Testing

2024/06/12 - AWS Mainframe Modernization Application Testing - 24 new api methods

Changes  AWS Mainframe Modernization Application Testing is an AWS Mainframe Modernization service feature that automates functional equivalence testing for mainframe application modernization and migration to AWS, and regression testing.

CreateTestCase (new) Link ¶

Creates a test case.

See also: AWS API Documentation

Request Syntax

client.create_test_case(
    name='string',
    description='string',
    steps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type name

string

param name

[REQUIRED]

The name of the test case.

type description

string

param description

The description of the test case.

type steps

list

param steps

[REQUIRED]

The steps in the test case.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

type clientToken

string

param clientToken

The client token of the test case.

This field is autopopulated if not provided.

type tags

dict

param tags

The specified tags of the test case.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'testCaseId': 'string',
    'testCaseVersion': 123
}

Response Structure

  • (dict) --

    • testCaseId (string) --

      The test case ID of the test case.

    • testCaseVersion (integer) --

      The test case version of the test case.

CreateTestSuite (new) Link ¶

Creates a test suite.

See also: AWS API Documentation

Request Syntax

client.create_test_suite(
    name='string',
    description='string',
    beforeSteps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    afterSteps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    testCases={
        'sequential': [
            'string',
        ]
    },
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type name

string

param name

[REQUIRED]

The name of the test suite.

type description

string

param description

The description of the test suite.

type beforeSteps

list

param beforeSteps

The before steps of the test suite.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

type afterSteps

list

param afterSteps

The after steps of the test suite.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

type testCases

dict

param testCases

[REQUIRED]

The test cases in the test suite.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: sequential.

  • sequential (list) --

    The sequential of the test case.

    • (string) --

type clientToken

string

param clientToken

The client token of the test suite.

This field is autopopulated if not provided.

type tags

dict

param tags

The tags of the test suite.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'testSuiteId': 'string',
    'testSuiteVersion': 123
}

Response Structure

  • (dict) --

    • testSuiteId (string) --

      The suite ID of the test suite.

    • testSuiteVersion (integer) --

      The suite version of the test suite.

DeleteTestCase (new) Link ¶

Deletes a test case.

See also: AWS API Documentation

Request Syntax

client.delete_test_case(
    testCaseId='string'
)
type testCaseId

string

param testCaseId

[REQUIRED]

The test case ID of the test case.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

GetTestSuite (new) Link ¶

Gets a test suite.

See also: AWS API Documentation

Request Syntax

client.get_test_suite(
    testSuiteId='string',
    testSuiteVersion=123
)
type testSuiteId

string

param testSuiteId

[REQUIRED]

The ID of the test suite.

type testSuiteVersion

integer

param testSuiteVersion

The version of the test suite.

rtype

dict

returns

Response Syntax

{
    'testSuiteId': 'string',
    'name': 'string',
    'latestVersion': {
        'version': 123,
        'status': 'Creating'|'Updating'|'Active'|'Failed'|'Deleting',
        'statusReason': 'string'
    },
    'testSuiteVersion': 123,
    'status': 'Creating'|'Updating'|'Active'|'Failed'|'Deleting',
    'statusReason': 'string',
    'testSuiteArn': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastUpdateTime': datetime(2015, 1, 1),
    'description': 'string',
    'beforeSteps': [
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    'afterSteps': [
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    'testCases': {
        'sequential': [
            'string',
        ]
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • testSuiteId (string) --

      The response ID of the test suite.

    • name (string) --

      The name of the test suite.

    • latestVersion (dict) --

      The latest version of the test suite.

      • version (integer) --

        The version of the test suite latest version.

      • status (string) --

        The status of the test suite latest version.

      • 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.

    • statusReason (string) --

      The status reason of the test suite.

    • testSuiteArn (string) --

      The test suite Amazon Resource Name (ARN).

    • creationTime (datetime) --

      The creation time of the test suite.

    • lastUpdateTime (datetime) --

      The last update time of the test suite.

    • description (string) --

      The description of the test suite.

    • beforeSteps (list) --

      The before steps of the test suite.

      • (dict) --

        Defines a step.

        • name (string) --

          The name of the step.

        • description (string) --

          The description of the step.

        • action (dict) --

          The action of the step.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: resourceAction, mainframeAction, compareAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • resourceAction (dict) --

            The resource action of the step action.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • m2ManagedApplicationAction (dict) --

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

              • resource (string) --

                The resource of the AWS Mainframe Modernization managed application action.

              • actionType (string) --

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

              • properties (dict) --

                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 (dict) --

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

              • resource (string) --

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

              • actionType (string) --

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

            • cloudFormationAction (dict) --

              The CloudFormation action of the resource action.

              • resource (string) --

                The resource of the CloudFormation action.

              • actionType (string) --

                The action type of the CloudFormation action.

          • mainframeAction (dict) --

            The mainframe action of the step action.

            • resource (string) --

              The resource of the mainframe action.

            • actionType (dict) --

              The action type of the mainframe action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: batch, tn3270. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • batch (dict) --

                The batch of the mainframe action type.

                • batchJobName (string) --

                  The job name of the batch.

                • batchJobParameters (dict) --

                  The batch job parameters of the batch.

                  • (string) --

                    • (string) --

                • exportDataSetNames (list) --

                  The export data set names of the batch.

                  • (string) --

              • tn3270 (dict) --

                The tn3270 port of the mainframe action type.

                • script (dict) --

                  The script of the TN3270 protocol.

                  • scriptLocation (string) --

                    The script location of the scripts.

                  • type (string) --

                    The type of the scripts.

                • exportDataSetNames (list) --

                  The data set names of the TN3270 protocol.

                  • (string) --

            • properties (dict) --

              The properties of the mainframe action.

              • dmsTaskArn (string) --

                The DMS task ARN of the mainframe action properties.

          • compareAction (dict) --

            The compare action of the step action.

            • input (dict) --

              The input of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file in the input.

                • sourceLocation (string) --

                  The source location of the input file.

                • targetLocation (string) --

                  The target location of the input file.

                • fileMetadata (dict) --

                  The file metadata of the input file.

                  Note

                  This is a Tagged Union structure. Only one of the following top level keys will be set: dataSets, databaseCDC. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
                  • dataSets (list) --

                    The data sets of the file metadata.

                    • (dict) --

                      Defines a data set.

                      • type (string) --

                        The type of the data set.

                      • name (string) --

                        The name of the data set.

                      • ccsid (string) --

                        The CCSID of the data set.

                      • format (string) --

                        The format of the data set.

                      • length (integer) --

                        The length of the data set.

                  • databaseCDC (dict) --

                    The database CDC of the file metadata.

                    • sourceMetadata (dict) --

                      The source metadata of the database CDC.

                      • type (string) --

                        The type of the source database metadata.

                      • captureTool (string) --

                        The capture tool of the source database metadata.

                    • targetMetadata (dict) --

                      The target metadata of the database CDC.

                      • type (string) --

                        The type of the target database metadata.

                      • captureTool (string) --

                        The capture tool of the target database metadata.

            • output (dict) --

              The output of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file of the output.

                • fileLocation (string) --

                  The file location of the output file.

    • afterSteps (list) --

      The after steps of the test suite.

      • (dict) --

        Defines a step.

        • name (string) --

          The name of the step.

        • description (string) --

          The description of the step.

        • action (dict) --

          The action of the step.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: resourceAction, mainframeAction, compareAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • resourceAction (dict) --

            The resource action of the step action.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • m2ManagedApplicationAction (dict) --

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

              • resource (string) --

                The resource of the AWS Mainframe Modernization managed application action.

              • actionType (string) --

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

              • properties (dict) --

                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 (dict) --

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

              • resource (string) --

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

              • actionType (string) --

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

            • cloudFormationAction (dict) --

              The CloudFormation action of the resource action.

              • resource (string) --

                The resource of the CloudFormation action.

              • actionType (string) --

                The action type of the CloudFormation action.

          • mainframeAction (dict) --

            The mainframe action of the step action.

            • resource (string) --

              The resource of the mainframe action.

            • actionType (dict) --

              The action type of the mainframe action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: batch, tn3270. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • batch (dict) --

                The batch of the mainframe action type.

                • batchJobName (string) --

                  The job name of the batch.

                • batchJobParameters (dict) --

                  The batch job parameters of the batch.

                  • (string) --

                    • (string) --

                • exportDataSetNames (list) --

                  The export data set names of the batch.

                  • (string) --

              • tn3270 (dict) --

                The tn3270 port of the mainframe action type.

                • script (dict) --

                  The script of the TN3270 protocol.

                  • scriptLocation (string) --

                    The script location of the scripts.

                  • type (string) --

                    The type of the scripts.

                • exportDataSetNames (list) --

                  The data set names of the TN3270 protocol.

                  • (string) --

            • properties (dict) --

              The properties of the mainframe action.

              • dmsTaskArn (string) --

                The DMS task ARN of the mainframe action properties.

          • compareAction (dict) --

            The compare action of the step action.

            • input (dict) --

              The input of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file in the input.

                • sourceLocation (string) --

                  The source location of the input file.

                • targetLocation (string) --

                  The target location of the input file.

                • fileMetadata (dict) --

                  The file metadata of the input file.

                  Note

                  This is a Tagged Union structure. Only one of the following top level keys will be set: dataSets, databaseCDC. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
                  • dataSets (list) --

                    The data sets of the file metadata.

                    • (dict) --

                      Defines a data set.

                      • type (string) --

                        The type of the data set.

                      • name (string) --

                        The name of the data set.

                      • ccsid (string) --

                        The CCSID of the data set.

                      • format (string) --

                        The format of the data set.

                      • length (integer) --

                        The length of the data set.

                  • databaseCDC (dict) --

                    The database CDC of the file metadata.

                    • sourceMetadata (dict) --

                      The source metadata of the database CDC.

                      • type (string) --

                        The type of the source database metadata.

                      • captureTool (string) --

                        The capture tool of the source database metadata.

                    • targetMetadata (dict) --

                      The target metadata of the database CDC.

                      • type (string) --

                        The type of the target database metadata.

                      • captureTool (string) --

                        The capture tool of the target database metadata.

            • output (dict) --

              The output of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file of the output.

                • fileLocation (string) --

                  The file location of the output file.

    • testCases (dict) --

      The test cases of the test suite.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: sequential. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • sequential (list) --

        The sequential of the test case.

        • (string) --

    • tags (dict) --

      The tags of the test suite.

      • (string) --

        • (string) --

GetTestCase (new) Link ¶

Gets a test case.

See also: AWS API Documentation

Request Syntax

client.get_test_case(
    testCaseId='string',
    testCaseVersion=123
)
type testCaseId

string

param testCaseId

[REQUIRED]

The request test ID of the test case.

type testCaseVersion

integer

param testCaseVersion

The test case version of the test case.

rtype

dict

returns

Response Syntax

{
    'testCaseId': 'string',
    'testCaseArn': 'string',
    'name': 'string',
    'description': 'string',
    'latestVersion': {
        'version': 123,
        'status': 'Active'|'Deleting',
        'statusReason': 'string'
    },
    'testCaseVersion': 123,
    'status': 'Active'|'Deleting',
    'statusReason': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastUpdateTime': datetime(2015, 1, 1),
    'steps': [
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • 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 (dict) --

      The latest version of the test case.

      • version (integer) --

        The version of the test case latest version.

      • status (string) --

        The status of the test case latest version.

      • 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.

    • statusReason (string) --

      The status reason of the test case.

    • creationTime (datetime) --

      The creation time of the test case.

    • lastUpdateTime (datetime) --

      The last update time of the test case.

    • steps (list) --

      The steps of the test case.

      • (dict) --

        Defines a step.

        • name (string) --

          The name of the step.

        • description (string) --

          The description of the step.

        • action (dict) --

          The action of the step.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: resourceAction, mainframeAction, compareAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • resourceAction (dict) --

            The resource action of the step action.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • m2ManagedApplicationAction (dict) --

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

              • resource (string) --

                The resource of the AWS Mainframe Modernization managed application action.

              • actionType (string) --

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

              • properties (dict) --

                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 (dict) --

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

              • resource (string) --

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

              • actionType (string) --

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

            • cloudFormationAction (dict) --

              The CloudFormation action of the resource action.

              • resource (string) --

                The resource of the CloudFormation action.

              • actionType (string) --

                The action type of the CloudFormation action.

          • mainframeAction (dict) --

            The mainframe action of the step action.

            • resource (string) --

              The resource of the mainframe action.

            • actionType (dict) --

              The action type of the mainframe action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: batch, tn3270. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • batch (dict) --

                The batch of the mainframe action type.

                • batchJobName (string) --

                  The job name of the batch.

                • batchJobParameters (dict) --

                  The batch job parameters of the batch.

                  • (string) --

                    • (string) --

                • exportDataSetNames (list) --

                  The export data set names of the batch.

                  • (string) --

              • tn3270 (dict) --

                The tn3270 port of the mainframe action type.

                • script (dict) --

                  The script of the TN3270 protocol.

                  • scriptLocation (string) --

                    The script location of the scripts.

                  • type (string) --

                    The type of the scripts.

                • exportDataSetNames (list) --

                  The data set names of the TN3270 protocol.

                  • (string) --

            • properties (dict) --

              The properties of the mainframe action.

              • dmsTaskArn (string) --

                The DMS task ARN of the mainframe action properties.

          • compareAction (dict) --

            The compare action of the step action.

            • input (dict) --

              The input of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file in the input.

                • sourceLocation (string) --

                  The source location of the input file.

                • targetLocation (string) --

                  The target location of the input file.

                • fileMetadata (dict) --

                  The file metadata of the input file.

                  Note

                  This is a Tagged Union structure. Only one of the following top level keys will be set: dataSets, databaseCDC. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
                  • dataSets (list) --

                    The data sets of the file metadata.

                    • (dict) --

                      Defines a data set.

                      • type (string) --

                        The type of the data set.

                      • name (string) --

                        The name of the data set.

                      • ccsid (string) --

                        The CCSID of the data set.

                      • format (string) --

                        The format of the data set.

                      • length (integer) --

                        The length of the data set.

                  • databaseCDC (dict) --

                    The database CDC of the file metadata.

                    • sourceMetadata (dict) --

                      The source metadata of the database CDC.

                      • type (string) --

                        The type of the source database metadata.

                      • captureTool (string) --

                        The capture tool of the source database metadata.

                    • targetMetadata (dict) --

                      The target metadata of the database CDC.

                      • type (string) --

                        The type of the target database metadata.

                      • captureTool (string) --

                        The capture tool of the target database metadata.

            • output (dict) --

              The output of the compare action.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • file (dict) --

                The file of the output.

                • fileLocation (string) --

                  The file location of the output file.

    • tags (dict) --

      The tags of the test case.

      • (string) --

        • (string) --

ListTestConfigurations (new) Link ¶

Lists test configurations.

See also: AWS API Documentation

Request Syntax

client.list_test_configurations(
    testConfigurationIds=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
type testConfigurationIds

list

param testConfigurationIds

The configuration IDs of the test configurations.

  • (string) --

type nextToken

string

param nextToken

The next token for the test configurations.

type maxResults

integer

param maxResults

The maximum results of the test configuration.

rtype

dict

returns

Response Syntax

{
    'testConfigurations': [
        {
            'testConfigurationId': 'string',
            'name': 'string',
            'statusReason': 'string',
            'latestVersion': 123,
            'testConfigurationArn': 'string',
            'status': 'Active'|'Deleting',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testConfigurations (list) --

      The test configurations.

      • (dict) --

        Specifies a test configuration summary.

        • testConfigurationId (string) --

          The test configuration ID of the test configuration summary.

        • name (string) --

          The name of the test configuration summary.

        • statusReason (string) --

          The status reason of the test configuration summary.

        • latestVersion (integer) --

          The latest version of the test configuration summary.

        • testConfigurationArn (string) --

          The test configuration ARN of the test configuration summary.

        • status (string) --

          The status of the test configuration summary.

        • creationTime (datetime) --

          The creation time of the test configuration summary.

        • lastUpdateTime (datetime) --

          The last update time of the test configuration summary.

    • nextToken (string) --

      The next token in the test configurations.

GetTestRunStep (new) Link ¶

Gets a test run step.

See also: AWS API Documentation

Request Syntax

client.get_test_run_step(
    testRunId='string',
    stepName='string',
    testCaseId='string',
    testSuiteId='string'
)
type testRunId

string

param testRunId

[REQUIRED]

The test run ID of the test run step.

type stepName

string

param stepName

[REQUIRED]

The step name of the test run step.

type testCaseId

string

param testCaseId

The test case ID of a test run step.

type testSuiteId

string

param testSuiteId

The test suite ID of a test run step.

rtype

dict

returns

Response Syntax

{
    'stepName': 'string',
    'testRunId': 'string',
    'testCaseId': 'string',
    'testCaseVersion': 123,
    'testSuiteId': 'string',
    'testSuiteVersion': 123,
    'beforeStep': True|False,
    'afterStep': True|False,
    'status': 'Success'|'Failed'|'Running',
    'statusReason': 'string',
    'runStartTime': datetime(2015, 1, 1),
    'runEndTime': datetime(2015, 1, 1),
    'stepRunSummary': {
        'mainframeAction': {
            'batch': {
                'stepInput': {
                    'resource': {
                        'm2ManagedApplication': {
                            'applicationId': 'string',
                            'runtime': 'MicroFocus',
                            'listenerPort': 123
                        },
                        'm2NonManagedApplication': {
                            'vpcEndpointServiceName': 'string',
                            'listenerPort': 123,
                            'runtime': 'BluAge',
                            'webAppName': 'string'
                        }
                    },
                    'batchJobName': 'string',
                    'batchJobParameters': {
                        'string': 'string'
                    },
                    'exportDataSetNames': [
                        'string',
                    ],
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'stepOutput': {
                    'dataSetExportLocation': 'string',
                    'dmsOutputLocation': 'string',
                    'dataSetDetails': [
                        {
                            'type': 'PS',
                            'name': 'string',
                            'ccsid': 'string',
                            'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                            'length': 123
                        },
                    ]
                }
            },
            'tn3270': {
                'stepInput': {
                    'resource': {
                        'm2ManagedApplication': {
                            'applicationId': 'string',
                            'runtime': 'MicroFocus',
                            'listenerPort': 123
                        },
                        'm2NonManagedApplication': {
                            'vpcEndpointServiceName': 'string',
                            'listenerPort': 123,
                            'runtime': 'BluAge',
                            'webAppName': 'string'
                        }
                    },
                    'script': {
                        'scriptLocation': 'string',
                        'type': 'Selenium'
                    },
                    'exportDataSetNames': [
                        'string',
                    ],
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'stepOutput': {
                    'dataSetExportLocation': 'string',
                    'dmsOutputLocation': 'string',
                    'dataSetDetails': [
                        {
                            'type': 'PS',
                            'name': 'string',
                            'ccsid': 'string',
                            'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                            'length': 123
                        },
                    ],
                    'scriptOutputLocation': 'string'
                }
            }
        },
        'compareAction': {
            'type': {
                'fileType': {
                    'datasets': {
                        'stepInput': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'sourceDataSets': [
                                {
                                    'type': 'PS',
                                    'name': 'string',
                                    'ccsid': 'string',
                                    'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                    'length': 123
                                },
                            ],
                            'targetDataSets': [
                                {
                                    'type': 'PS',
                                    'name': 'string',
                                    'ccsid': 'string',
                                    'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                    'length': 123
                                },
                            ]
                        },
                        'stepOutput': {
                            'comparisonOutputLocation': 'string',
                            'comparisonStatus': 'Different'|'Equivalent'|'Equal'
                        }
                    },
                    'databaseCDC': {
                        'stepInput': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'outputLocation': 'string',
                            'sourceMetadata': {
                                'type': 'z/OS-DB2',
                                'captureTool': 'Precisely'|'AWS DMS'
                            },
                            'targetMetadata': {
                                'type': 'PostgreSQL',
                                'captureTool': 'Precisely'|'AWS DMS'
                            }
                        },
                        'stepOutput': {
                            'comparisonOutputLocation': 'string',
                            'comparisonStatus': 'Different'|'Equivalent'|'Equal'
                        }
                    }
                }
            }
        },
        'resourceAction': {
            'cloudFormation': {
                'createCloudformation': {
                    'stepInput': {
                        'templateLocation': 'string',
                        'parameters': {
                            'string': 'string'
                        }
                    },
                    'stepOutput': {
                        'stackId': 'string',
                        'exports': {
                            'string': 'string'
                        }
                    }
                },
                'deleteCloudformation': {
                    'stepInput': {
                        'stackId': 'string'
                    },
                    'stepOutput': {}
                }
            },
            'm2ManagedApplication': {
                'stepInput': {
                    'applicationId': 'string',
                    'runtime': 'string',
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 123,
                    'actionType': 'Configure'|'Deconfigure',
                    'properties': {
                        'forceStop': True|False,
                        'importDataSetLocation': 'string'
                    }
                },
                'stepOutput': {
                    'importDataSetSummary': {
                        'string': 'string'
                    }
                }
            },
            'm2NonManagedApplication': {
                'stepInput': {
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 123,
                    'runtime': 'BluAge',
                    'webAppName': 'string',
                    'actionType': 'Configure'|'Deconfigure'
                },
                'stepOutput': {}
            }
        }
    }
}

Response Structure

  • (dict) --

    • 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.

    • statusReason (string) --

      The status reason of the test run step.

    • runStartTime (datetime) --

      The run start time of the test run step.

    • runEndTime (datetime) --

      The run end time of the test run step.

    • stepRunSummary (dict) --

      The step run summary of the test run step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: mainframeAction, compareAction, resourceAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • mainframeAction (dict) --

        The mainframe action of the step run summary.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: batch, tn3270. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • batch (dict) --

          The batch of the mainframe action summary.

          • stepInput (dict) --

            The step input of the batch summary.

            • resource (dict) --

              The resource of the batch step input.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: m2ManagedApplication, m2NonManagedApplication. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • m2ManagedApplication (dict) --

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

                • applicationId (string) --

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

                • runtime (string) --

                  The runtime of the AWS Mainframe Modernization managed application summary.

                • listenerPort (integer) --

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

              • m2NonManagedApplication (dict) --

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

                • vpcEndpointServiceName (string) --

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

                • listenerPort (integer) --

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

                • runtime (string) --

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

                • webAppName (string) --

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

            • batchJobName (string) --

              The batch job name of the batch step input.

            • batchJobParameters (dict) --

              The batch job parameters of the batch step input.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch step input.

              • (string) --

            • properties (dict) --

              The properties of the batch step input.

              • dmsTaskArn (string) --

                The DMS task ARN of the mainframe action properties.

          • stepOutput (dict) --

            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 (list) --

              The data set details of the batch step output.

              • (dict) --

                Defines a data set.

                • type (string) --

                  The type of the data set.

                • name (string) --

                  The name of the data set.

                • ccsid (string) --

                  The CCSID of the data set.

                • format (string) --

                  The format of the data set.

                • length (integer) --

                  The length of the data set.

        • tn3270 (dict) --

          The tn3270 port of the mainframe action summary.

          • stepInput (dict) --

            The step input of the TN3270 summary.

            • resource (dict) --

              The resource of the TN3270 step input.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: m2ManagedApplication, m2NonManagedApplication. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • m2ManagedApplication (dict) --

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

                • applicationId (string) --

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

                • runtime (string) --

                  The runtime of the AWS Mainframe Modernization managed application summary.

                • listenerPort (integer) --

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

              • m2NonManagedApplication (dict) --

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

                • vpcEndpointServiceName (string) --

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

                • listenerPort (integer) --

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

                • runtime (string) --

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

                • webAppName (string) --

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

            • script (dict) --

              The script of the TN3270 step input.

              • scriptLocation (string) --

                The script location of the script summary.

              • type (string) --

                The type of the script summary.

            • exportDataSetNames (list) --

              The export data set names of the TN3270 step input.

              • (string) --

            • properties (dict) --

              The properties of the TN3270 step input.

              • dmsTaskArn (string) --

                The DMS task ARN of the mainframe action properties.

          • stepOutput (dict) --

            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 (list) --

              The data set details of the TN3270 step output.

              • (dict) --

                Defines a data set.

                • type (string) --

                  The type of the data set.

                • name (string) --

                  The name of the data set.

                • ccsid (string) --

                  The CCSID of the data set.

                • format (string) --

                  The format of the data set.

                • length (integer) --

                  The length of the data set.

            • scriptOutputLocation (string) --

              The script output location of the TN3270 step output.

      • compareAction (dict) --

        The compare action of the step run summary.

        • type (dict) --

          The type of the compare action summary.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: fileType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • fileType (dict) --

            The file type of the file.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: datasets, databaseCDC. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • datasets (dict) --

              The data sets in the compare file type.

              • stepInput (dict) --

                The step input of the compare data sets summary.

                • sourceLocation (string) --

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

                • targetLocation (string) --

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

                • sourceDataSets (list) --

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

                  • (dict) --

                    Defines a data set.

                    • type (string) --

                      The type of the data set.

                    • name (string) --

                      The name of the data set.

                    • ccsid (string) --

                      The CCSID of the data set.

                    • format (string) --

                      The format of the data set.

                    • length (integer) --

                      The length of the data set.

                • targetDataSets (list) --

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

                  • (dict) --

                    Defines a data set.

                    • type (string) --

                      The type of the data set.

                    • name (string) --

                      The name of the data set.

                    • ccsid (string) --

                      The CCSID of the data set.

                    • format (string) --

                      The format of the data set.

                    • length (integer) --

                      The length of the data set.

              • stepOutput (dict) --

                The step output of the compare data sets summary.

                • comparisonOutputLocation (string) --

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

                • comparisonStatus (string) --

                  The comparison status of the compare data sets step output.

            • databaseCDC (dict) --

              The database CDC of the compare file type.

              • stepInput (dict) --

                The step input of the compare database CDC summary.

                • sourceLocation (string) --

                  The source location of the compare database CDC step input.

                • targetLocation (string) --

                  The target location of the compare database CDC step input.

                • outputLocation (string) --

                  The output location of the compare database CDC step input.

                • sourceMetadata (dict) --

                  The source metadata of the compare database CDC step input.

                  • type (string) --

                    The type of the source database metadata.

                  • captureTool (string) --

                    The capture tool of the source database metadata.

                • targetMetadata (dict) --

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

                  • type (string) --

                    The type of the target database metadata.

                  • captureTool (string) --

                    The capture tool of the target database metadata.

              • stepOutput (dict) --

                The step output of the compare database CDC summary.

                • comparisonOutputLocation (string) --

                  The comparison output of the compare database CDC step output.

                • comparisonStatus (string) --

                  The comparison status of the compare database CDC step output.

      • resourceAction (dict) --

        The resource action of the step run summary.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation, m2ManagedApplication, m2NonManagedApplication. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • cloudFormation (dict) --

          The CloudFormation template of the resource action summary.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: createCloudformation, deleteCloudformation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • createCloudformation (dict) --

            Creates the CloudFormation summary of the step.

            • stepInput (dict) --

              The step input of the CloudFormation summary.

              • templateLocation (string) --

                The template location of the CloudFormation step input.

              • parameters (dict) --

                The CloudFormation properties of the CloudFormation step input.

                • (string) --

                  • (string) --

            • stepOutput (dict) --

              The step output of the CloudFormation summary.

              • stackId (string) --

                The stack ID of the CloudFormation step output.

              • exports (dict) --

                The exports of the CloudFormation step output.

                • (string) --

                  • (string) --

          • deleteCloudformation (dict) --

            Deletes the CloudFormation summary of the CloudFormation step summary.

            • stepInput (dict) --

              The step input of the deleted CloudFormation summary.

              • stackId (string) --

                The stack ID of the deleted CloudFormation step input.

            • stepOutput (dict) --

              The step output of the deleted CloudFormation summary.

        • m2ManagedApplication (dict) --

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

          • stepInput (dict) --

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

            • applicationId (string) --

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

            • runtime (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 (string) --

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

            • properties (dict) --

              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 (dict) --

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

            • importDataSetSummary (dict) --

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

              • (string) --

                • (string) --

        • m2NonManagedApplication (dict) --

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

          • stepInput (dict) --

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

            • vpcEndpointServiceName (string) --

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

            • listenerPort (integer) --

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

            • runtime (string) --

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

            • webAppName (string) --

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

            • actionType (string) --

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

          • stepOutput (dict) --

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

ListTestRunTestCases (new) Link ¶

Lists test run test cases.

See also: AWS API Documentation

Request Syntax

client.list_test_run_test_cases(
    testRunId='string',
    nextToken='string',
    maxResults=123
)
type testRunId

string

param testRunId

[REQUIRED]

The test run ID of the test cases.

type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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

rtype

dict

returns

Response Syntax

{
    'testRunTestCases': [
        {
            'testCaseId': 'string',
            'testCaseVersion': 123,
            'testRunId': 'string',
            'status': 'Success'|'Running'|'Failed',
            'statusReason': 'string',
            'runStartTime': datetime(2015, 1, 1),
            'runEndTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testRunTestCases (list) --

      The test run of the test cases.

      • (dict) --

        Specifies the test case run summary.

        • testCaseId (string) --

          The test case id of the test case run summary.

        • testCaseVersion (integer) --

          The test case version of the test case run summary.

        • testRunId (string) --

          The test run id of the test case run summary.

        • status (string) --

          The status of the test case run summary.

        • statusReason (string) --

          The status reason of the test case run summary.

        • runStartTime (datetime) --

          The run start time of the test case run summary.

        • runEndTime (datetime) --

          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.

DeleteTestConfiguration (new) Link ¶

Deletes a test configuration.

See also: AWS API Documentation

Request Syntax

client.delete_test_configuration(
    testConfigurationId='string'
)
type testConfigurationId

string

param testConfigurationId

[REQUIRED]

The test ID of the test configuration.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

StartTestRun (new) Link ¶

Starts a test run.

See also: AWS API Documentation

Request Syntax

client.start_test_run(
    testSuiteId='string',
    testConfigurationId='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type testSuiteId

string

param testSuiteId

[REQUIRED]

The test suite ID of the test run.

type testConfigurationId

string

param testConfigurationId

The configuration ID of the test run.

type clientToken

string

param clientToken

The client token of the test run.

This field is autopopulated if not provided.

type tags

dict

param tags

The tags of the test run.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'testRunId': 'string',
    'testRunStatus': 'Success'|'Running'|'Failed'|'Deleting'
}

Response Structure

  • (dict) --

    • testRunId (string) --

      The test run ID of the test run.

    • testRunStatus (string) --

      The test run status of the test run.

ListTestCases (new) Link ¶

Lists test cases.

See also: AWS API Documentation

Request Syntax

client.list_test_cases(
    testCaseIds=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
type testCaseIds

list

param testCaseIds

The IDs of the test cases.

  • (string) --

type nextToken

string

param nextToken

The next token of the test cases.

type maxResults

integer

param maxResults

The maximum results of the test case.

rtype

dict

returns

Response Syntax

{
    'testCases': [
        {
            'testCaseId': 'string',
            'testCaseArn': 'string',
            'name': 'string',
            'statusReason': 'string',
            'latestVersion': 123,
            'status': 'Active'|'Deleting',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testCases (list) --

      The test cases in an application.

      • (dict) --

        Specifies a test case summary.

        • testCaseId (string) --

          The test case ID of the test case summary.

        • testCaseArn (string) --

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

        • name (string) --

          The name of the test case summary.

        • statusReason (string) --

          The status reason of the test case summary.

        • latestVersion (integer) --

          The latest version of the test case summary.

        • status (string) --

          The status of the test case summary.

        • creationTime (datetime) --

          The creation time of the test case summary.

        • lastUpdateTime (datetime) --

          The last update time of the test case summary.

    • nextToken (string) --

      The next token in test cases.

ListTestRuns (new) Link ¶

Lists test runs.

See also: AWS API Documentation

Request Syntax

client.list_test_runs(
    testSuiteId='string',
    testRunIds=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
type testSuiteId

string

param testSuiteId

The test suite ID of the test runs.

type testRunIds

list

param testRunIds

The test run IDs of the test runs.

  • (string) --

type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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

rtype

dict

returns

Response Syntax

{
    'testRuns': [
        {
            'testRunId': 'string',
            'testRunArn': 'string',
            'testSuiteId': 'string',
            'testSuiteVersion': 123,
            'testConfigurationId': 'string',
            'testConfigurationVersion': 123,
            'status': 'Success'|'Running'|'Failed'|'Deleting',
            'statusReason': 'string',
            'runStartTime': datetime(2015, 1, 1),
            'runEndTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testRuns (list) --

      The test runs of the response query.

      • (dict) --

        Specifies a test run summary.

        • testRunId (string) --

          The test run ID of the test run summary.

        • testRunArn (string) --

          The test run ARN of the test run summary.

        • testSuiteId (string) --

          The test suite ID of the test run summary.

        • testSuiteVersion (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 (string) --

          The status of the test run summary.

        • statusReason (string) --

          The status reason of the test run summary.

        • runStartTime (datetime) --

          The run start time of the test run summary.

        • runEndTime (datetime) --

          The run end time of the test run summary.

    • nextToken (string) --

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

UntagResource (new) Link ¶

Untags a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tagKeys

list

param tagKeys

[REQUIRED]

The tag keys of the resource.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

TagResource (new) Link ¶

Specifies tags of a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the tag resource.

type tags

dict

param tags

[REQUIRED]

The tags of the resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

CreateTestConfiguration (new) Link ¶

Creates a test configuration.

See also: AWS API Documentation

Request Syntax

client.create_test_configuration(
    name='string',
    description='string',
    resources=[
        {
            'name': 'string',
            'type': {
                'cloudFormation': {
                    'templateLocation': 'string',
                    'parameters': {
                        'string': 'string'
                    }
                },
                'm2ManagedApplication': {
                    'applicationId': 'string',
                    'runtime': 'MicroFocus',
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string'
                },
                'm2NonManagedApplication': {
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string',
                    'runtime': 'BluAge',
                    'webAppName': 'string'
                }
            }
        },
    ],
    properties={
        'string': 'string'
    },
    clientToken='string',
    tags={
        'string': 'string'
    },
    serviceSettings={
        'kmsKeyId': 'string'
    }
)
type name

string

param name

[REQUIRED]

The name of the test configuration.

type description

string

param description

The description of the test configuration.

type resources

list

param resources

[REQUIRED]

The defined resources of the test configuration.

  • (dict) --

    Specifies a resource.

    • name (string) -- [REQUIRED]

      The name of the resource.

    • type (dict) -- [REQUIRED]

      The type of the resource.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: cloudFormation, m2ManagedApplication, m2NonManagedApplication.

      • cloudFormation (dict) --

        The CloudFormation template of the resource type.

        • templateLocation (string) -- [REQUIRED]

          The template location of the CloudFormation template.

        • parameters (dict) --

          The CloudFormation properties in the CloudFormation template.

          • (string) --

            • (string) --

      • m2ManagedApplication (dict) --

        The AWS Mainframe Modernization managed application of the resource type.

        • applicationId (string) -- [REQUIRED]

          The application ID of the AWS Mainframe Modernization managed application.

        • runtime (string) -- [REQUIRED]

          The runtime of the AWS Mainframe Modernization managed application.

        • 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 (dict) --

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

        • vpcEndpointServiceName (string) -- [REQUIRED]

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

        • listenerPort (string) -- [REQUIRED]

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

        • runtime (string) -- [REQUIRED]

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

        • webAppName (string) --

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

type properties

dict

param properties

The properties of the test configuration.

  • (string) --

    • (string) --

type clientToken

string

param clientToken

The client token of the test configuration.

This field is autopopulated if not provided.

type tags

dict

param tags

The tags of the test configuration.

  • (string) --

    • (string) --

type serviceSettings

dict

param serviceSettings

The service settings of the test configuration.

  • kmsKeyId (string) --

    The KMS key ID of the service settings.

rtype

dict

returns

Response Syntax

{
    'testConfigurationId': 'string',
    'testConfigurationVersion': 123
}

Response Structure

  • (dict) --

    • testConfigurationId (string) --

      The test configuration ID.

    • testConfigurationVersion (integer) --

      The test configuration version.

ListTestRunSteps (new) Link ¶

Lists test run steps.

See also: AWS API Documentation

Request Syntax

client.list_test_run_steps(
    testRunId='string',
    testCaseId='string',
    testSuiteId='string',
    nextToken='string',
    maxResults=123
)
type testRunId

string

param testRunId

[REQUIRED]

The test run ID of the test run steps.

type testCaseId

string

param testCaseId

The test case ID of the test run steps.

type testSuiteId

string

param testSuiteId

The test suite ID of the test run steps.

type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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

rtype

dict

returns

Response Syntax

{
    'testRunSteps': [
        {
            'stepName': 'string',
            'testRunId': 'string',
            'testCaseId': 'string',
            'testCaseVersion': 123,
            'testSuiteId': 'string',
            'testSuiteVersion': 123,
            'beforeStep': True|False,
            'afterStep': True|False,
            'status': 'Success'|'Failed'|'Running',
            'statusReason': 'string',
            'runStartTime': datetime(2015, 1, 1),
            'runEndTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testRunSteps (list) --

      The test run steps of the response query.

      • (dict) --

        Specifies a test run step summary.

        • stepName (string) --

          The step name of the test run step summary.

        • testRunId (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 (string) --

          The status of the test run step summary.

        • statusReason (string) --

          The status reason of the test run step summary.

        • runStartTime (datetime) --

          The run start time of the test run step summary.

        • runEndTime (datetime) --

          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.

GetTestConfiguration (new) Link ¶

Gets a test configuration.

See also: AWS API Documentation

Request Syntax

client.get_test_configuration(
    testConfigurationId='string',
    testConfigurationVersion=123
)
type testConfigurationId

string

param testConfigurationId

[REQUIRED]

The request test configuration ID.

type testConfigurationVersion

integer

param testConfigurationVersion

The test configuration version.

rtype

dict

returns

Response Syntax

{
    'testConfigurationId': 'string',
    'name': 'string',
    'testConfigurationArn': 'string',
    'latestVersion': {
        'version': 123,
        'status': 'Active'|'Deleting',
        'statusReason': 'string'
    },
    'testConfigurationVersion': 123,
    'status': 'Active'|'Deleting',
    'statusReason': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastUpdateTime': datetime(2015, 1, 1),
    'description': 'string',
    'resources': [
        {
            'name': 'string',
            'type': {
                'cloudFormation': {
                    'templateLocation': 'string',
                    'parameters': {
                        'string': 'string'
                    }
                },
                'm2ManagedApplication': {
                    'applicationId': 'string',
                    'runtime': 'MicroFocus',
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string'
                },
                'm2NonManagedApplication': {
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string',
                    'runtime': 'BluAge',
                    'webAppName': 'string'
                }
            }
        },
    ],
    'properties': {
        'string': 'string'
    },
    'tags': {
        'string': 'string'
    },
    'serviceSettings': {
        'kmsKeyId': 'string'
    }
}

Response Structure

  • (dict) --

    • testConfigurationId (string) --

      The response test configuration ID.

    • name (string) --

      The test configuration name

    • testConfigurationArn (string) --

      The test configuration Amazon Resource Name (ARN).

    • latestVersion (dict) --

      The latest version of the test configuration.

      • version (integer) --

        The version of the test configuration latest version.

      • status (string) --

        The status of the test configuration latest version.

      • 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.

    • statusReason (string) --

      The status reason of the test configuration.

    • creationTime (datetime) --

      The creation time of the test configuration.

    • lastUpdateTime (datetime) --

      The last update time of the test configuration.

    • description (string) --

      The description of the test configuration.

    • resources (list) --

      The resources of the test configuration.

      • (dict) --

        Specifies a resource.

        • name (string) --

          The name of the resource.

        • type (dict) --

          The type of the resource.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation, m2ManagedApplication, m2NonManagedApplication. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • cloudFormation (dict) --

            The CloudFormation template of the resource type.

            • templateLocation (string) --

              The template location of the CloudFormation template.

            • parameters (dict) --

              The CloudFormation properties in the CloudFormation template.

              • (string) --

                • (string) --

          • m2ManagedApplication (dict) --

            The AWS Mainframe Modernization managed application of the resource type.

            • applicationId (string) --

              The application ID of the AWS Mainframe Modernization managed application.

            • runtime (string) --

              The runtime of the AWS Mainframe Modernization managed application.

            • 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 (dict) --

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

            • vpcEndpointServiceName (string) --

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

            • listenerPort (string) --

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

            • runtime (string) --

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

            • webAppName (string) --

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

    • properties (dict) --

      The properties of the test configuration.

      • (string) --

        • (string) --

    • tags (dict) --

      The tags of the test configuration.

      • (string) --

        • (string) --

    • serviceSettings (dict) --

      The service settings of the test configuration.

      • kmsKeyId (string) --

        The KMS key ID of the service settings.

UpdateTestSuite (new) Link ¶

Updates a test suite.

See also: AWS API Documentation

Request Syntax

client.update_test_suite(
    testSuiteId='string',
    description='string',
    beforeSteps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    afterSteps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ],
    testCases={
        'sequential': [
            'string',
        ]
    }
)
type testSuiteId

string

param testSuiteId

[REQUIRED]

The test suite ID of the test suite.

type description

string

param description

The description of the test suite.

type beforeSteps

list

param beforeSteps

The before steps for the test suite.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

type afterSteps

list

param afterSteps

The after steps of the test suite.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

type testCases

dict

param testCases

The test cases in the test suite.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: sequential.

  • sequential (list) --

    The sequential of the test case.

    • (string) --

rtype

dict

returns

Response Syntax

{
    'testSuiteId': 'string',
    'testSuiteVersion': 123
}

Response Structure

  • (dict) --

    • testSuiteId (string) --

      The test suite ID of the test suite.

    • testSuiteVersion (integer) --

      The test suite version of the test suite.

DeleteTestRun (new) Link ¶

Deletes a test run.

See also: AWS API Documentation

Request Syntax

client.delete_test_run(
    testRunId='string'
)
type testRunId

string

param testRunId

[REQUIRED]

The run ID of the test run.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UpdateTestConfiguration (new) Link ¶

Updates a test configuration.

See also: AWS API Documentation

Request Syntax

client.update_test_configuration(
    testConfigurationId='string',
    description='string',
    resources=[
        {
            'name': 'string',
            'type': {
                'cloudFormation': {
                    'templateLocation': 'string',
                    'parameters': {
                        'string': 'string'
                    }
                },
                'm2ManagedApplication': {
                    'applicationId': 'string',
                    'runtime': 'MicroFocus',
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string'
                },
                'm2NonManagedApplication': {
                    'vpcEndpointServiceName': 'string',
                    'listenerPort': 'string',
                    'runtime': 'BluAge',
                    'webAppName': 'string'
                }
            }
        },
    ],
    properties={
        'string': 'string'
    },
    serviceSettings={
        'kmsKeyId': 'string'
    }
)
type testConfigurationId

string

param testConfigurationId

[REQUIRED]

The test configuration ID of the test configuration.

type description

string

param description

The description of the test configuration.

type resources

list

param resources

The resources of the test configuration.

  • (dict) --

    Specifies a resource.

    • name (string) -- [REQUIRED]

      The name of the resource.

    • type (dict) -- [REQUIRED]

      The type of the resource.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: cloudFormation, m2ManagedApplication, m2NonManagedApplication.

      • cloudFormation (dict) --

        The CloudFormation template of the resource type.

        • templateLocation (string) -- [REQUIRED]

          The template location of the CloudFormation template.

        • parameters (dict) --

          The CloudFormation properties in the CloudFormation template.

          • (string) --

            • (string) --

      • m2ManagedApplication (dict) --

        The AWS Mainframe Modernization managed application of the resource type.

        • applicationId (string) -- [REQUIRED]

          The application ID of the AWS Mainframe Modernization managed application.

        • runtime (string) -- [REQUIRED]

          The runtime of the AWS Mainframe Modernization managed application.

        • 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 (dict) --

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

        • vpcEndpointServiceName (string) -- [REQUIRED]

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

        • listenerPort (string) -- [REQUIRED]

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

        • runtime (string) -- [REQUIRED]

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

        • webAppName (string) --

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

type properties

dict

param properties

The properties of the test configuration.

  • (string) --

    • (string) --

type serviceSettings

dict

param serviceSettings

The service settings of the test configuration.

  • kmsKeyId (string) --

    The KMS key ID of the service settings.

rtype

dict

returns

Response Syntax

{
    'testConfigurationId': 'string',
    'testConfigurationVersion': 123
}

Response Structure

  • (dict) --

    • testConfigurationId (string) --

      The configuration ID of the test configuration.

    • testConfigurationVersion (integer) --

      The configuration version of the test configuration.

UpdateTestCase (new) Link ¶

Updates a test case.

See also: AWS API Documentation

Request Syntax

client.update_test_case(
    testCaseId='string',
    description='string',
    steps=[
        {
            'name': 'string',
            'description': 'string',
            'action': {
                'resourceAction': {
                    'm2ManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure',
                        'properties': {
                            'forceStop': True|False,
                            'importDataSetLocation': 'string'
                        }
                    },
                    'm2NonManagedApplicationAction': {
                        'resource': 'string',
                        'actionType': 'Configure'|'Deconfigure'
                    },
                    'cloudFormationAction': {
                        'resource': 'string',
                        'actionType': 'Create'|'Delete'
                    }
                },
                'mainframeAction': {
                    'resource': 'string',
                    'actionType': {
                        'batch': {
                            'batchJobName': 'string',
                            'batchJobParameters': {
                                'string': 'string'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        },
                        'tn3270': {
                            'script': {
                                'scriptLocation': 'string',
                                'type': 'Selenium'
                            },
                            'exportDataSetNames': [
                                'string',
                            ]
                        }
                    },
                    'properties': {
                        'dmsTaskArn': 'string'
                    }
                },
                'compareAction': {
                    'input': {
                        'file': {
                            'sourceLocation': 'string',
                            'targetLocation': 'string',
                            'fileMetadata': {
                                'dataSets': [
                                    {
                                        'type': 'PS',
                                        'name': 'string',
                                        'ccsid': 'string',
                                        'format': 'FIXED'|'VARIABLE'|'LINE_SEQUENTIAL',
                                        'length': 123
                                    },
                                ],
                                'databaseCDC': {
                                    'sourceMetadata': {
                                        'type': 'z/OS-DB2',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    },
                                    'targetMetadata': {
                                        'type': 'PostgreSQL',
                                        'captureTool': 'Precisely'|'AWS DMS'
                                    }
                                }
                            }
                        }
                    },
                    'output': {
                        'file': {
                            'fileLocation': 'string'
                        }
                    }
                }
            }
        },
    ]
)
type testCaseId

string

param testCaseId

[REQUIRED]

The test case ID of the test case.

type description

string

param description

The description of the test case.

type steps

list

param steps

The steps of the test case.

  • (dict) --

    Defines a step.

    • name (string) -- [REQUIRED]

      The name of the step.

    • description (string) --

      The description of the step.

    • action (dict) -- [REQUIRED]

      The action of the step.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: resourceAction, mainframeAction, compareAction.

      • resourceAction (dict) --

        The resource action of the step action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: m2ManagedApplicationAction, m2NonManagedApplicationAction, cloudFormationAction.

        • m2ManagedApplicationAction (dict) --

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

          • resource (string) -- [REQUIRED]

            The resource of the AWS Mainframe Modernization managed application action.

          • actionType (string) -- [REQUIRED]

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

          • properties (dict) --

            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 (dict) --

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

          • resource (string) -- [REQUIRED]

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

          • actionType (string) -- [REQUIRED]

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

        • cloudFormationAction (dict) --

          The CloudFormation action of the resource action.

          • resource (string) -- [REQUIRED]

            The resource of the CloudFormation action.

          • actionType (string) --

            The action type of the CloudFormation action.

      • mainframeAction (dict) --

        The mainframe action of the step action.

        • resource (string) -- [REQUIRED]

          The resource of the mainframe action.

        • actionType (dict) -- [REQUIRED]

          The action type of the mainframe action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: batch, tn3270.

          • batch (dict) --

            The batch of the mainframe action type.

            • batchJobName (string) -- [REQUIRED]

              The job name of the batch.

            • batchJobParameters (dict) --

              The batch job parameters of the batch.

              • (string) --

                • (string) --

            • exportDataSetNames (list) --

              The export data set names of the batch.

              • (string) --

          • tn3270 (dict) --

            The tn3270 port of the mainframe action type.

            • script (dict) -- [REQUIRED]

              The script of the TN3270 protocol.

              • scriptLocation (string) -- [REQUIRED]

                The script location of the scripts.

              • type (string) -- [REQUIRED]

                The type of the scripts.

            • exportDataSetNames (list) --

              The data set names of the TN3270 protocol.

              • (string) --

        • properties (dict) --

          The properties of the mainframe action.

          • dmsTaskArn (string) --

            The DMS task ARN of the mainframe action properties.

      • compareAction (dict) --

        The compare action of the step action.

        • input (dict) -- [REQUIRED]

          The input of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file in the input.

            • sourceLocation (string) -- [REQUIRED]

              The source location of the input file.

            • targetLocation (string) -- [REQUIRED]

              The target location of the input file.

            • fileMetadata (dict) -- [REQUIRED]

              The file metadata of the input file.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, databaseCDC.

              • dataSets (list) --

                The data sets of the file metadata.

                • (dict) --

                  Defines a data set.

                  • type (string) -- [REQUIRED]

                    The type of the data set.

                  • name (string) -- [REQUIRED]

                    The name of the data set.

                  • ccsid (string) -- [REQUIRED]

                    The CCSID of the data set.

                  • format (string) -- [REQUIRED]

                    The format of the data set.

                  • length (integer) -- [REQUIRED]

                    The length of the data set.

              • databaseCDC (dict) --

                The database CDC of the file metadata.

                • sourceMetadata (dict) -- [REQUIRED]

                  The source metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the source database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the source database metadata.

                • targetMetadata (dict) -- [REQUIRED]

                  The target metadata of the database CDC.

                  • type (string) -- [REQUIRED]

                    The type of the target database metadata.

                  • captureTool (string) -- [REQUIRED]

                    The capture tool of the target database metadata.

        • output (dict) --

          The output of the compare action.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: file.

          • file (dict) --

            The file of the output.

            • fileLocation (string) --

              The file location of the output file.

rtype

dict

returns

Response Syntax

{
    'testCaseId': 'string',
    'testCaseVersion': 123
}

Response Structure

  • (dict) --

    • testCaseId (string) --

      The test case ID of the test case.

    • testCaseVersion (integer) --

      The test case version of the test case.

DeleteTestSuite (new) Link ¶

Deletes a test suite.

See also: AWS API Documentation

Request Syntax

client.delete_test_suite(
    testSuiteId='string'
)
type testSuiteId

string

param testSuiteId

[REQUIRED]

The test ID of the test suite.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

Lists tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      The tags of the resource.

      • (string) --

        • (string) --

ListTestSuites (new) Link ¶

Lists test suites.

See also: AWS API Documentation

Request Syntax

client.list_test_suites(
    testSuiteIds=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
type testSuiteIds

list

param testSuiteIds

The suite ID of the test suites.

  • (string) --

type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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

rtype

dict

returns

Response Syntax

{
    'testSuites': [
        {
            'testSuiteId': 'string',
            'name': 'string',
            'statusReason': 'string',
            'latestVersion': 123,
            'testSuiteArn': 'string',
            'status': 'Creating'|'Updating'|'Active'|'Failed'|'Deleting',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • testSuites (list) --

      The test suites returned with the response query.

      • (dict) --

        Specifies the test suite summary.

        • testSuiteId (string) --

          The test suite ID of the test suite summary.

        • name (string) --

          The name of the test suite summary.

        • statusReason (string) --

          The status reason of the test suite summary.

        • latestVersion (integer) --

          The latest version of the test suite summary.

        • testSuiteArn (string) --

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

        • status (string) --

          The status of the test suite summary.

        • creationTime (datetime) --

          The creation time of the test suite summary.

        • lastUpdateTime (datetime) --

          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.