MainframeModernizationApplicationTesting / Client / get_test_case

get_test_case

MainframeModernizationApplicationTesting.Client.get_test_case(**kwargs)

Gets a test case.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• testCaseId (string) –

  [REQUIRED]

  The request test ID of the test case.

• testCaseVersion (integer) – The test case version of the test case.

Return type:

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) –

Exceptions

• MainframeModernizationApplicationTesting.Client.exceptions.ThrottlingException

• MainframeModernizationApplicationTesting.Client.exceptions.ResourceNotFoundException

• MainframeModernizationApplicationTesting.Client.exceptions.AccessDeniedException

• MainframeModernizationApplicationTesting.Client.exceptions.ValidationException

• MainframeModernizationApplicationTesting.Client.exceptions.InternalServerException