MainframeModernizationApplicationTesting / Client / get_test_run_step

get_test_run_step#

MainframeModernizationApplicationTesting.Client.get_test_run_step(**kwargs)#

Gets a test run step.

Request Syntax

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

Parameters:

testRunId (string) –
[REQUIRED]

The test run ID of the test run step.
stepName (string) –
[REQUIRED]

The step name of the test run step.
testCaseId (string) – The test case ID of a test run step.
testSuiteId (string) – The test suite ID of a test run step.

Return type:

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.

Exceptions

MainframeModernizationApplicationTesting.Client.exceptions.ThrottlingException
MainframeModernizationApplicationTesting.Client.exceptions.ResourceNotFoundException
MainframeModernizationApplicationTesting.Client.exceptions.AccessDeniedException
MainframeModernizationApplicationTesting.Client.exceptions.ValidationException
MainframeModernizationApplicationTesting.Client.exceptions.InternalServerException