MainframeModernizationApplicationTesting / Client / create_test_suite
create_test_suite#
- MainframeModernizationApplicationTesting.Client.create_test_suite(**kwargs)#
Creates a test suite.
See also: AWS API Documentation
Request Syntax
response = 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' } )
- Parameters:
name (string) –
[REQUIRED]
The name 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) – [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.
afterSteps (list) –
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.
testCases (dict) –
[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) –
clientToken (string) –
The client token of the test suite.
This field is autopopulated if not provided.
tags (dict) –
The tags of the test suite.
(string) –
(string) –
- Return type:
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.
Exceptions
MainframeModernizationApplicationTesting.Client.exceptions.ServiceQuotaExceededExceptionMainframeModernizationApplicationTesting.Client.exceptions.ThrottlingExceptionMainframeModernizationApplicationTesting.Client.exceptions.AccessDeniedExceptionMainframeModernizationApplicationTesting.Client.exceptions.ValidationExceptionMainframeModernizationApplicationTesting.Client.exceptions.ConflictExceptionMainframeModernizationApplicationTesting.Client.exceptions.InternalServerException