SDK for PHP V3

AWS Mainframe Modernization Application Testing 2022-12-06

Client: Aws\AppTest\AppTestClient
Service ID: apptest
Version: 2022-12-06

This page describes the parameters and results for the operations of the AWS Mainframe Modernization Application Testing (2022-12-06), and shows how to use the Aws\AppTest\AppTestClient object to call the described operations. This documentation is specific to the 2022-12-06 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateTestCase ( array $params = [] )
Creates a test case.
CreateTestConfiguration ( array $params = [] )
Creates a test configuration.
CreateTestSuite ( array $params = [] )
Creates a test suite.
DeleteTestCase ( array $params = [] )
Deletes a test case.
DeleteTestConfiguration ( array $params = [] )
Deletes a test configuration.
DeleteTestRun ( array $params = [] )
Deletes a test run.
DeleteTestSuite ( array $params = [] )
Deletes a test suite.
GetTestCase ( array $params = [] )
Gets a test case.
GetTestConfiguration ( array $params = [] )
Gets a test configuration.
GetTestRunStep ( array $params = [] )
Gets a test run step.
GetTestSuite ( array $params = [] )
Gets a test suite.
ListTagsForResource ( array $params = [] )
Lists tags for a resource.
ListTestCases ( array $params = [] )
Lists test cases.
ListTestConfigurations ( array $params = [] )
Lists test configurations.
ListTestRunSteps ( array $params = [] )
Lists test run steps.
ListTestRunTestCases ( array $params = [] )
Lists test run test cases.
ListTestRuns ( array $params = [] )
Lists test runs.
ListTestSuites ( array $params = [] )
Lists test suites.
StartTestRun ( array $params = [] )
Starts a test run.
TagResource ( array $params = [] )
Specifies tags of a resource.
UntagResource ( array $params = [] )
Untags a resource.
UpdateTestCase ( array $params = [] )
Updates a test case.
UpdateTestConfiguration ( array $params = [] )
Updates a test configuration.
UpdateTestSuite ( array $params = [] )
Updates a test suite.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListTestCases
ListTestConfigurations
ListTestRunSteps
ListTestRunTestCases
ListTestRuns
ListTestSuites

Operations

CreateTestCase 

$result = $client->createTestCase([/* ... */]);
$promise = $client->createTestCaseAsync([/* ... */]);

Creates a test case.

Parameter Syntax

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

Parameter Details

Members
clientToken
Type: string

The client token of the test case.

description
Type: string

The description of the test case.

name
Required: Yes
Type: string

The name of the test case.

steps
Required: Yes
Type: Array of Step structures

The steps in the test case.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The specified tags of the test case.

Result Syntax

[
    'testCaseId' => '<string>',
    'testCaseVersion' => <integer>,
]

Result Details

Members
testCaseId
Required: Yes
Type: string

The test case ID of the test case.

testCaseVersion
Required: Yes
Type: int

The test case version of the test case.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

CreateTestConfiguration 

$result = $client->createTestConfiguration([/* ... */]);
$promise = $client->createTestConfigurationAsync([/* ... */]);

Creates a test configuration.

Parameter Syntax

$result = $client->createTestConfiguration([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'properties' => ['<string>', ...],
    'resources' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'type' => [ // REQUIRED
                'cloudFormation' => [
                    'parameters' => ['<string>', ...],
                    'templateLocation' => '<string>', // REQUIRED
                ],
                'm2ManagedApplication' => [
                    'applicationId' => '<string>', // REQUIRED
                    'listenerPort' => '<string>',
                    'runtime' => 'MicroFocus', // REQUIRED
                    'vpcEndpointServiceName' => '<string>',
                ],
                'm2NonManagedApplication' => [
                    'listenerPort' => '<string>', // REQUIRED
                    'runtime' => 'BluAge', // REQUIRED
                    'vpcEndpointServiceName' => '<string>', // REQUIRED
                    'webAppName' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'serviceSettings' => [
        'kmsKeyId' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
Type: string

The client token of the test configuration.

description
Type: string

The description of the test configuration.

name
Required: Yes
Type: string

The name of the test configuration.

properties
Type: Associative array of custom strings keys (String) to strings

The properties of the test configuration.

resources
Required: Yes
Type: Array of Resource structures

The defined resources of the test configuration.

serviceSettings
Type: ServiceSettings structure

The service settings of the test configuration.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test configuration.

Result Syntax

[
    'testConfigurationId' => '<string>',
    'testConfigurationVersion' => <integer>,
]

Result Details

Members
testConfigurationId
Required: Yes
Type: string

The test configuration ID.

testConfigurationVersion
Required: Yes
Type: int

The test configuration version.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

CreateTestSuite 

$result = $client->createTestSuite([/* ... */]);
$promise = $client->createTestSuiteAsync([/* ... */]);

Creates a test suite.

Parameter Syntax

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

Parameter Details

Members
afterSteps
Type: Array of Step structures

The after steps of the test suite.

beforeSteps
Type: Array of Step structures

The before steps of the test suite.

clientToken
Type: string

The client token of the test suite.

description
Type: string

The description of the test suite.

name
Required: Yes
Type: string

The name of the test suite.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test suite.

testCases
Required: Yes
Type: TestCases structure

The test cases in the test suite.

Result Syntax

[
    'testSuiteId' => '<string>',
    'testSuiteVersion' => <integer>,
]

Result Details

Members
testSuiteId
Required: Yes
Type: string

The suite ID of the test suite.

testSuiteVersion
Required: Yes
Type: int

The suite version of the test suite.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteTestCase 

$result = $client->deleteTestCase([/* ... */]);
$promise = $client->deleteTestCaseAsync([/* ... */]);

Deletes a test case.

Parameter Syntax

$result = $client->deleteTestCase([
    'testCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Members
testCaseId
Required: Yes
Type: string

The test case ID of the test case.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteTestConfiguration 

$result = $client->deleteTestConfiguration([/* ... */]);
$promise = $client->deleteTestConfigurationAsync([/* ... */]);

Deletes a test configuration.

Parameter Syntax

$result = $client->deleteTestConfiguration([
    'testConfigurationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
testConfigurationId
Required: Yes
Type: string

The test ID of the test configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteTestRun 

$result = $client->deleteTestRun([/* ... */]);
$promise = $client->deleteTestRunAsync([/* ... */]);

Deletes a test run.

Parameter Syntax

$result = $client->deleteTestRun([
    'testRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members
testRunId
Required: Yes
Type: string

The run ID of the test run.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteTestSuite 

$result = $client->deleteTestSuite([/* ... */]);
$promise = $client->deleteTestSuiteAsync([/* ... */]);

Deletes a test suite.

Parameter Syntax

$result = $client->deleteTestSuite([
    'testSuiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
testSuiteId
Required: Yes
Type: string

The test ID of the test suite.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

GetTestCase 

$result = $client->getTestCase([/* ... */]);
$promise = $client->getTestCaseAsync([/* ... */]);

Gets a test case.

Parameter Syntax

$result = $client->getTestCase([
    'testCaseId' => '<string>', // REQUIRED
    'testCaseVersion' => <integer>,
]);

Parameter Details

Members
testCaseId
Required: Yes
Type: string

The request test ID of the test case.

testCaseVersion
Type: int

The test case version of the test case.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'lastUpdateTime' => <DateTime>,
    'latestVersion' => [
        'status' => 'Active|Deleting',
        'statusReason' => '<string>',
        'version' => <integer>,
    ],
    'name' => '<string>',
    'status' => 'Active|Deleting',
    'statusReason' => '<string>',
    'steps' => [
        [
            'action' => [
                'compareAction' => [
                    'input' => [
                        'file' => [
                            'fileMetadata' => [
                                'dataSets' => [
                                    [
                                        'ccsid' => '<string>',
                                        'format' => 'FIXED|VARIABLE|LINE_SEQUENTIAL',
                                        'length' => <integer>,
                                        'name' => '<string>',
                                        'type' => 'PS',
                                    ],
                                    // ...
                                ],
                                'databaseCDC' => [
                                    'sourceMetadata' => [
                                        'captureTool' => 'Precisely|AWS DMS',
                                        'type' => 'z/OS-DB2',
                                    ],
                                    'targetMetadata' => [
                                        'captureTool' => 'Precisely|AWS DMS',
                                        'type' => 'PostgreSQL',
                                    ],
                                ],
                            ],
                            'sourceLocation' => '<string>',
                            'targetLocation' => '<string>',
                        ],
                    ],
                    'output' => [
                        'file' => [
                            'fileLocation' => '<string>',
                        ],
                    ],
                ],
                'mainframeAction' => [
                    'actionType' => [
                        'batch' => [
                            'batchJobName' => '<string>',
                            'batchJobParameters' => ['<string>', ...],
                            'exportDataSetNames' => ['<string>', ...],
                        ],
                        'tn3270' => [
                            'exportDataSetNames' => ['<string>', ...],
                            'script' => [
                                'scriptLocation' => '<string>',
                                'type' => 'Selenium',
                            ],
                        ],
                    ],
                    'properties' => [
                        'dmsTaskArn' => '<string>',
                    ],
                    'resource' => '<string>',
                ],
                'resourceAction' => [
                    'cloudFormationAction' => [
                        'actionType' => 'Create|Delete',
                        'resource' => '<string>',
                    ],
                    'm2ManagedApplicationAction' => [
                        'actionType' => 'Configure|Deconfigure',
                        'properties' => [
                            'forceStop' => true || false,
                            'importDataSetLocation' => '<string>',
                        ],
                        'resource' => '<string>',
                    ],
                    'm2NonManagedApplicationAction' => [
                        'actionType' => 'Configure|Deconfigure',
                        'resource' => '<string>',
                    ],
                ],
            ],
            'description' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'testCaseArn' => '<string>',
    'testCaseId' => '<string>',
    'testCaseVersion' => <integer>,
]

Result Details

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test case.

description
Type: string

The description of the test case.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test case.

latestVersion
Required: Yes
Type: TestCaseLatestVersion structure

The latest version of the test case.

name
Required: Yes
Type: string

The name of the test case.

status
Required: Yes
Type: string

The status of the test case.

statusReason
Type: string

The status reason of the test case.

steps
Required: Yes
Type: Array of Step structures

The steps of the test case.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test case.

testCaseArn
Required: Yes
Type: string

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

testCaseId
Required: Yes
Type: string

The response test ID of the test case.

testCaseVersion
Required: Yes
Type: int

The case version of the test case.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

GetTestConfiguration 

$result = $client->getTestConfiguration([/* ... */]);
$promise = $client->getTestConfigurationAsync([/* ... */]);

Gets a test configuration.

Parameter Syntax

$result = $client->getTestConfiguration([
    'testConfigurationId' => '<string>', // REQUIRED
    'testConfigurationVersion' => <integer>,
]);

Parameter Details

Members
testConfigurationId
Required: Yes
Type: string

The request test configuration ID.

testConfigurationVersion
Type: int

The test configuration version.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'lastUpdateTime' => <DateTime>,
    'latestVersion' => [
        'status' => 'Active|Deleting',
        'statusReason' => '<string>',
        'version' => <integer>,
    ],
    'name' => '<string>',
    'properties' => ['<string>', ...],
    'resources' => [
        [
            'name' => '<string>',
            'type' => [
                'cloudFormation' => [
                    'parameters' => ['<string>', ...],
                    'templateLocation' => '<string>',
                ],
                'm2ManagedApplication' => [
                    'applicationId' => '<string>',
                    'listenerPort' => '<string>',
                    'runtime' => 'MicroFocus',
                    'vpcEndpointServiceName' => '<string>',
                ],
                'm2NonManagedApplication' => [
                    'listenerPort' => '<string>',
                    'runtime' => 'BluAge',
                    'vpcEndpointServiceName' => '<string>',
                    'webAppName' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'serviceSettings' => [
        'kmsKeyId' => '<string>',
    ],
    'status' => 'Active|Deleting',
    'statusReason' => '<string>',
    'tags' => ['<string>', ...],
    'testConfigurationArn' => '<string>',
    'testConfigurationId' => '<string>',
    'testConfigurationVersion' => <integer>,
]

Result Details

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test configuration.

description
Type: string

The description of the test configuration.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test configuration.

latestVersion
Required: Yes
Type: TestConfigurationLatestVersion structure

The latest version of the test configuration.

name
Required: Yes
Type: string

The test configuration name

properties
Required: Yes
Type: Associative array of custom strings keys (String) to strings

The properties of the test configuration.

resources
Required: Yes
Type: Array of Resource structures

The resources of the test configuration.

serviceSettings
Type: ServiceSettings structure

The service settings of the test configuration.

status
Required: Yes
Type: string

The status of the test configuration.

statusReason
Type: string

The status reason of the test configuration.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test configuration.

testConfigurationArn
Required: Yes
Type: string

The test configuration Amazon Resource Name (ARN).

testConfigurationId
Required: Yes
Type: string

The response test configuration ID.

testConfigurationVersion
Required: Yes
Type: int

The test configuration version.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

GetTestRunStep 

$result = $client->getTestRunStep([/* ... */]);
$promise = $client->getTestRunStepAsync([/* ... */]);

Gets a test run step.

Parameter Syntax

$result = $client->getTestRunStep([
    'stepName' => '<string>', // REQUIRED
    'testCaseId' => '<string>',
    'testRunId' => '<string>', // REQUIRED
    'testSuiteId' => '<string>',
]);

Parameter Details

Members
stepName
Required: Yes
Type: string

The step name of the test run step.

testCaseId
Type: string

The test case ID of a test run step.

testRunId
Required: Yes
Type: string

The test run ID of the test run step.

testSuiteId
Type: string

The test suite ID of a test run step.

Result Syntax

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

Result Details

Members
afterStep
Type: boolean

The after steps of the test run step.

beforeStep
Type: boolean

The before steps of the test run step.

runEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run end time of the test run step.

runStartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run start time of the test run step.

status
Required: Yes
Type: string

The status of the test run step.

statusReason
Type: string

The status reason of the test run step.

stepName
Required: Yes
Type: string

The step name of the test run step.

stepRunSummary
Type: StepRunSummary structure

The step run summary of the test run step.

testCaseId
Type: string

The test case ID of the test run step.

testCaseVersion
Type: int

The test case version of the test run step.

testRunId
Required: Yes
Type: string

The test run ID of the test run step.

testSuiteId
Type: string

The test suite ID of the test run step.

testSuiteVersion
Type: int

The test suite version of the test run step.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

GetTestSuite 

$result = $client->getTestSuite([/* ... */]);
$promise = $client->getTestSuiteAsync([/* ... */]);

Gets a test suite.

Parameter Syntax

$result = $client->getTestSuite([
    'testSuiteId' => '<string>', // REQUIRED
    'testSuiteVersion' => <integer>,
]);

Parameter Details

Members
testSuiteId
Required: Yes
Type: string

The ID of the test suite.

testSuiteVersion
Type: int

The version of the test suite.

Result Syntax

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

Result Details

Members
afterSteps
Required: Yes
Type: Array of Step structures

The after steps of the test suite.

beforeSteps
Required: Yes
Type: Array of Step structures

The before steps of the test suite.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test suite.

description
Type: string

The description of the test suite.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test suite.

latestVersion
Required: Yes
Type: TestSuiteLatestVersion structure

The latest version of the test suite.

name
Required: Yes
Type: string

The name of the test suite.

status
Type: string

The status of the test suite.

statusReason
Type: string

The status reason of the test suite.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test suite.

testCases
Required: Yes
Type: TestCases structure

The test cases of the test suite.

testSuiteArn
Required: Yes
Type: string

The test suite Amazon Resource Name (ARN).

testSuiteId
Required: Yes
Type: string

The response ID of the test suite.

testSuiteVersion
Required: Yes
Type: int

The version of the test suite.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the resource.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestCases 

$result = $client->listTestCases([/* ... */]);
$promise = $client->listTestCasesAsync([/* ... */]);

Lists test cases.

Parameter Syntax

$result = $client->listTestCases([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testCaseIds' => ['<string>', ...],
]);

Parameter Details

Members
maxResults
Type: int

The maximum results of the test case.

nextToken
Type: string

The next token of the test cases.

testCaseIds
Type: Array of strings

The IDs of the test cases.

Result Syntax

[
    'nextToken' => '<string>',
    'testCases' => [
        [
            'creationTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'latestVersion' => <integer>,
            'name' => '<string>',
            'status' => 'Active|Deleting',
            'statusReason' => '<string>',
            'testCaseArn' => '<string>',
            'testCaseId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The next token in test cases.

testCases
Required: Yes
Type: Array of TestCaseSummary structures

The test cases in an application.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestConfigurations 

$result = $client->listTestConfigurations([/* ... */]);
$promise = $client->listTestConfigurationsAsync([/* ... */]);

Lists test configurations.

Parameter Syntax

$result = $client->listTestConfigurations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testConfigurationIds' => ['<string>', ...],
]);

Parameter Details

Members
maxResults
Type: int

The maximum results of the test configuration.

nextToken
Type: string

The next token for the test configurations.

testConfigurationIds
Type: Array of strings

The configuration IDs of the test configurations.

Result Syntax

[
    'nextToken' => '<string>',
    'testConfigurations' => [
        [
            'creationTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'latestVersion' => <integer>,
            'name' => '<string>',
            'status' => 'Active|Deleting',
            'statusReason' => '<string>',
            'testConfigurationArn' => '<string>',
            'testConfigurationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The next token in the test configurations.

testConfigurations
Required: Yes
Type: Array of TestConfigurationSummary structures

The test configurations.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestRunSteps 

$result = $client->listTestRunSteps([/* ... */]);
$promise = $client->listTestRunStepsAsync([/* ... */]);

Lists test run steps.

Parameter Syntax

$result = $client->listTestRunSteps([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testCaseId' => '<string>',
    'testRunId' => '<string>', // REQUIRED
    'testSuiteId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: string

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

testCaseId
Type: string

The test case ID of the test run steps.

testRunId
Required: Yes
Type: string

The test run ID of the test run steps.

testSuiteId
Type: string

The test suite ID of the test run steps.

Result Syntax

[
    'nextToken' => '<string>',
    'testRunSteps' => [
        [
            'afterStep' => true || false,
            'beforeStep' => true || false,
            'runEndTime' => <DateTime>,
            'runStartTime' => <DateTime>,
            'status' => 'Success|Failed|Running',
            'statusReason' => '<string>',
            'stepName' => '<string>',
            'testCaseId' => '<string>',
            'testCaseVersion' => <integer>,
            'testRunId' => '<string>',
            'testSuiteId' => '<string>',
            'testSuiteVersion' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

testRunSteps
Required: Yes
Type: Array of TestRunStepSummary structures

The test run steps of the response query.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestRunTestCases 

$result = $client->listTestRunTestCases([/* ... */]);
$promise = $client->listTestRunTestCasesAsync([/* ... */]);

Lists test run test cases.

Parameter Syntax

$result = $client->listTestRunTestCases([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: string

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

testRunId
Required: Yes
Type: string

The test run ID of the test cases.

Result Syntax

[
    'nextToken' => '<string>',
    'testRunTestCases' => [
        [
            'runEndTime' => <DateTime>,
            'runStartTime' => <DateTime>,
            'status' => 'Success|Running|Failed',
            'statusReason' => '<string>',
            'testCaseId' => '<string>',
            'testCaseVersion' => <integer>,
            'testRunId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

testRunTestCases
Required: Yes
Type: Array of TestCaseRunSummary structures

The test run of the test cases.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestRuns 

$result = $client->listTestRuns([/* ... */]);
$promise = $client->listTestRunsAsync([/* ... */]);

Lists test runs.

Parameter Syntax

$result = $client->listTestRuns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testRunIds' => ['<string>', ...],
    'testSuiteId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: string

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

testRunIds
Type: Array of strings

The test run IDs of the test runs.

testSuiteId
Type: string

The test suite ID of the test runs.

Result Syntax

[
    'nextToken' => '<string>',
    'testRuns' => [
        [
            'runEndTime' => <DateTime>,
            'runStartTime' => <DateTime>,
            'status' => 'Success|Running|Failed|Deleting',
            'statusReason' => '<string>',
            'testConfigurationId' => '<string>',
            'testConfigurationVersion' => <integer>,
            'testRunArn' => '<string>',
            'testRunId' => '<string>',
            'testSuiteId' => '<string>',
            'testSuiteVersion' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

testRuns
Required: Yes
Type: Array of TestRunSummary structures

The test runs of the response query.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTestSuites 

$result = $client->listTestSuites([/* ... */]);
$promise = $client->listTestSuitesAsync([/* ... */]);

Lists test suites.

Parameter Syntax

$result = $client->listTestSuites([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'testSuiteIds' => ['<string>', ...],
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: string

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

testSuiteIds
Type: Array of strings

The suite ID of the test suites.

Result Syntax

[
    'nextToken' => '<string>',
    'testSuites' => [
        [
            'creationTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'latestVersion' => <integer>,
            'name' => '<string>',
            'status' => 'Creating|Updating|Active|Failed|Deleting',
            'statusReason' => '<string>',
            'testSuiteArn' => '<string>',
            'testSuiteId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

testSuites
Required: Yes
Type: Array of TestSuiteSummary structures

The test suites returned with the response query.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

StartTestRun 

$result = $client->startTestRun([/* ... */]);
$promise = $client->startTestRunAsync([/* ... */]);

Starts a test run.

Parameter Syntax

$result = $client->startTestRun([
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
    'testConfigurationId' => '<string>',
    'testSuiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The client token of the test run.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the test run.

testConfigurationId
Type: string

The configuration ID of the test run.

testSuiteId
Required: Yes
Type: string

The test suite ID of the test run.

Result Syntax

[
    'testRunId' => '<string>',
    'testRunStatus' => 'Success|Running|Failed|Deleting',
]

Result Details

Members
testRunId
Required: Yes
Type: string

The test run ID of the test run.

testRunStatus
Required: Yes
Type: string

The test run status of the test run.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Specifies tags of a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:

One or more quotas for AWS Application Testing exceeds the limit.

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untags a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
Required: Yes
Type: Array of strings

The tag keys of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

InternalServerException:

An unexpected error occurred during the processing of the request.

UpdateTestCase 

$result = $client->updateTestCase([/* ... */]);
$promise = $client->updateTestCaseAsync([/* ... */]);

Updates a test case.

Parameter Syntax

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

Parameter Details

Members
description
Type: string

The description of the test case.

steps
Type: Array of Step structures

The steps of the test case.

testCaseId
Required: Yes
Type: string

The test case ID of the test case.

Result Syntax

[
    'testCaseId' => '<string>',
    'testCaseVersion' => <integer>,
]

Result Details

Members
testCaseId
Required: Yes
Type: string

The test case ID of the test case.

testCaseVersion
Required: Yes
Type: int

The test case version of the test case.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

UpdateTestConfiguration 

$result = $client->updateTestConfiguration([/* ... */]);
$promise = $client->updateTestConfigurationAsync([/* ... */]);

Updates a test configuration.

Parameter Syntax

$result = $client->updateTestConfiguration([
    'description' => '<string>',
    'properties' => ['<string>', ...],
    'resources' => [
        [
            'name' => '<string>', // REQUIRED
            'type' => [ // REQUIRED
                'cloudFormation' => [
                    'parameters' => ['<string>', ...],
                    'templateLocation' => '<string>', // REQUIRED
                ],
                'm2ManagedApplication' => [
                    'applicationId' => '<string>', // REQUIRED
                    'listenerPort' => '<string>',
                    'runtime' => 'MicroFocus', // REQUIRED
                    'vpcEndpointServiceName' => '<string>',
                ],
                'm2NonManagedApplication' => [
                    'listenerPort' => '<string>', // REQUIRED
                    'runtime' => 'BluAge', // REQUIRED
                    'vpcEndpointServiceName' => '<string>', // REQUIRED
                    'webAppName' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'serviceSettings' => [
        'kmsKeyId' => '<string>',
    ],
    'testConfigurationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the test configuration.

properties
Type: Associative array of custom strings keys (String) to strings

The properties of the test configuration.

resources
Type: Array of Resource structures

The resources of the test configuration.

serviceSettings
Type: ServiceSettings structure

The service settings of the test configuration.

testConfigurationId
Required: Yes
Type: string

The test configuration ID of the test configuration.

Result Syntax

[
    'testConfigurationId' => '<string>',
    'testConfigurationVersion' => <integer>,
]

Result Details

Members
testConfigurationId
Required: Yes
Type: string

The configuration ID of the test configuration.

testConfigurationVersion
Required: Yes
Type: int

The configuration version of the test configuration.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

UpdateTestSuite 

$result = $client->updateTestSuite([/* ... */]);
$promise = $client->updateTestSuiteAsync([/* ... */]);

Updates a test suite.

Parameter Syntax

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

Parameter Details

Members
afterSteps
Type: Array of Step structures

The after steps of the test suite.

beforeSteps
Type: Array of Step structures

The before steps for the test suite.

description
Type: string

The description of the test suite.

testCases
Type: TestCases structure

The test cases in the test suite.

testSuiteId
Required: Yes
Type: string

The test suite ID of the test suite.

Result Syntax

[
    'testSuiteId' => '<string>',
    'testSuiteVersion' => <integer>,
]

Result Details

Members
testSuiteId
Required: Yes
Type: string

The test suite ID of the test suite.

testSuiteVersion
Type: int

The test suite version of the test suite.

Errors

ThrottlingException:

The number of requests made exceeds the limit.

ResourceNotFoundException:

The specified resource was not found.

AccessDeniedException:

The account or role doesn't have the right permissions to make the request.

ValidationException:

One or more parameter provided in the request is not valid.

ConflictException:

The parameters provided in the request conflict with existing resources.

InternalServerException:

An unexpected error occurred during the processing of the request.

Shapes

AccessDeniedException

Description

The account or role doesn't have the right permissions to make the request.

Members
message
Required: Yes
Type: string

Batch

Description

Defines a batch.

Members
batchJobName
Required: Yes
Type: string

The job name of the batch.

batchJobParameters
Type: Associative array of custom strings keys (String) to strings

The batch job parameters of the batch.

exportDataSetNames
Type: Array of strings

The export data set names of the batch.

BatchStepInput

Description

Defines a batch step input.

Members
batchJobName
Required: Yes
Type: string

The batch job name of the batch step input.

batchJobParameters
Type: Associative array of custom strings keys (String) to strings

The batch job parameters of the batch step input.

exportDataSetNames
Type: Array of strings

The export data set names of the batch step input.

properties
Type: MainframeActionProperties structure

The properties of the batch step input.

resource
Required: Yes
Type: MainframeResourceSummary structure

The resource of the batch step input.

BatchStepOutput

Description

Defines a batch step output.

Members
dataSetDetails
Type: Array of DataSet structures

The data set details of the batch step output.

dataSetExportLocation
Type: string

The data set export location of the batch step output.

dmsOutputLocation
Type: string

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

BatchSummary

Description

Summarizes a batch job.

Members
stepInput
Required: Yes
Type: BatchStepInput structure

The step input of the batch summary.

stepOutput
Type: BatchStepOutput structure

The step output of the batch summary.

CloudFormation

Description

Specifies the CloudFormation template and its parameters.

Members
parameters
Type: Associative array of custom strings keys (String) to strings

The CloudFormation properties in the CloudFormation template.

templateLocation
Required: Yes
Type: string

The template location of the CloudFormation template.

CloudFormationAction

Description

Specifies the CloudFormation action.

Members
actionType
Type: string

The action type of the CloudFormation action.

resource
Required: Yes
Type: string

The resource of the CloudFormation action.

CloudFormationStepSummary

Description

Specifies the CloudFormation step summary.

Members
createCloudformation
Type: CreateCloudFormationSummary structure

Creates the CloudFormation summary of the step.

deleteCloudformation
Type: DeleteCloudFormationSummary structure

Deletes the CloudFormation summary of the CloudFormation step summary.

CompareAction

Description

Compares the action.

Members
input
Required: Yes
Type: Input structure

The input of the compare action.

output
Type: Output structure

The output of the compare action.

CompareActionSummary

Description

Specifies the compare action summary.

Members
type
Required: Yes
Type: File structure

The type of the compare action summary.

CompareDataSetsStepInput

Description

Specifies the compare data sets step input.

Members
sourceDataSets
Required: Yes
Type: Array of DataSet structures

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

sourceLocation
Required: Yes
Type: string

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

targetDataSets
Required: Yes
Type: Array of DataSet structures

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

targetLocation
Required: Yes
Type: string

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

CompareDataSetsStepOutput

Description

Specifies the compare data sets step output.

Members
comparisonOutputLocation
Required: Yes
Type: string

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

comparisonStatus
Required: Yes
Type: string

The comparison status of the compare data sets step output.

CompareDataSetsSummary

Description

Compares data sets summary.

Members
stepInput
Required: Yes
Type: CompareDataSetsStepInput structure

The step input of the compare data sets summary.

stepOutput
Type: CompareDataSetsStepOutput structure

The step output of the compare data sets summary.

CompareDatabaseCDCStepInput

Description

Compares the database Change Data Capture (CDC) step input.

Members
outputLocation
Type: string

The output location of the compare database CDC step input.

sourceLocation
Required: Yes
Type: string

The source location of the compare database CDC step input.

sourceMetadata
Required: Yes
Type: SourceDatabaseMetadata structure

The source metadata of the compare database CDC step input.

targetLocation
Required: Yes
Type: string

The target location of the compare database CDC step input.

targetMetadata
Required: Yes
Type: TargetDatabaseMetadata structure

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

CompareDatabaseCDCStepOutput

Description

Compares the database CDC step output.

Members
comparisonOutputLocation
Required: Yes
Type: string

The comparison output of the compare database CDC step output.

comparisonStatus
Required: Yes
Type: string

The comparison status of the compare database CDC step output.

CompareDatabaseCDCSummary

Description

Compares the database CDC summary.

Members
stepInput
Required: Yes
Type: CompareDatabaseCDCStepInput structure

The step input of the compare database CDC summary.

stepOutput
Type: CompareDatabaseCDCStepOutput structure

The step output of the compare database CDC summary.

CompareFileType

Description

Compares the file type.

Members
databaseCDC
Type: CompareDatabaseCDCSummary structure

The database CDC of the compare file type.

datasets
Type: CompareDataSetsSummary structure

The data sets in the compare file type.

ConflictException

Description

The parameters provided in the request conflict with existing resources.

Members
message
Required: Yes
Type: string
resourceId
Type: string

The resource ID of the conflicts with existing resources.

resourceType
Type: string

The resource type of the conflicts with existing resources.

CreateCloudFormationStepInput

Description

Creates the CloudFormation step input.

Members
parameters
Type: Associative array of custom strings keys (String) to strings

The CloudFormation properties of the CloudFormation step input.

templateLocation
Required: Yes
Type: string

The template location of the CloudFormation step input.

CreateCloudFormationStepOutput

Description

Creates a CloudFormation step output.

Members
exports
Type: Associative array of custom strings keys (String) to strings

The exports of the CloudFormation step output.

stackId
Required: Yes
Type: string

The stack ID of the CloudFormation step output.

CreateCloudFormationSummary

Description

Creates a CloudFormation summary.

Members
stepInput
Required: Yes
Type: CreateCloudFormationStepInput structure

The step input of the CloudFormation summary.

stepOutput
Type: CreateCloudFormationStepOutput structure

The step output of the CloudFormation summary.

DataSet

Description

Defines a data set.

Members
ccsid
Required: Yes
Type: string

The CCSID of the data set.

format
Required: Yes
Type: string

The format of the data set.

length
Required: Yes
Type: int

The length of the data set.

name
Required: Yes
Type: string

The name of the data set.

type
Required: Yes
Type: string

The type of the data set.

DatabaseCDC

Description

Defines the Change Data Capture (CDC) of the database.

Members
sourceMetadata
Required: Yes
Type: SourceDatabaseMetadata structure

The source metadata of the database CDC.

targetMetadata
Required: Yes
Type: TargetDatabaseMetadata structure

The target metadata of the database CDC.

DeleteCloudFormationStepInput

Description

Deletes the CloudFormation step input.

Members
stackId
Required: Yes
Type: string

The stack ID of the deleted CloudFormation step input.

DeleteCloudFormationStepOutput

Description

Deletes the CloudFormation summary step output.

Members

DeleteCloudFormationSummary

Description

Deletes the CloudFormation summary.

Members
stepInput
Required: Yes
Type: DeleteCloudFormationStepInput structure

The step input of the deleted CloudFormation summary.

stepOutput
Type: DeleteCloudFormationStepOutput structure

The step output of the deleted CloudFormation summary.

File

Description

Defines a file.

Members
fileType
Type: CompareFileType structure

The file type of the file.

FileMetadata

Description

Specifies a file metadata.

Members
dataSets
Type: Array of DataSet structures

The data sets of the file metadata.

databaseCDC
Type: DatabaseCDC structure

The database CDC of the file metadata.

Input

Description

Specifies the input.

Members
file
Type: InputFile structure

The file in the input.

InputFile

Description

Specifies the input file.

Members
fileMetadata
Required: Yes
Type: FileMetadata structure

The file metadata of the input file.

sourceLocation
Required: Yes
Type: string

The source location of the input file.

targetLocation
Required: Yes
Type: string

The target location of the input file.

InternalServerException

Description

An unexpected error occurred during the processing of the request.

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

The number of seconds to retry the query.

M2ManagedActionProperties

Description

Specifies the AWS Mainframe Modernization managed action properties.

Members
forceStop
Type: boolean

Force stops the AWS Mainframe Modernization managed action properties.

importDataSetLocation
Type: string

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

M2ManagedApplication

Description

Specifies the AWS Mainframe Modernization managed application.

Members
applicationId
Required: Yes
Type: string

The application ID of the AWS Mainframe Modernization managed application.

listenerPort
Type: string

The listener port of the AWS Mainframe Modernization managed application.

runtime
Required: Yes
Type: string

The runtime of the AWS Mainframe Modernization managed application.

vpcEndpointServiceName
Type: string

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

M2ManagedApplicationAction

Description

Specifies the AWS Mainframe Modernization managed application action.

Members
actionType
Required: Yes
Type: string

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

properties
Type: M2ManagedActionProperties structure

The properties of the AWS Mainframe Modernization managed application action.

resource
Required: Yes
Type: string

The resource of the AWS Mainframe Modernization managed application action.

M2ManagedApplicationStepInput

Description

Specifies the AWS Mainframe Modernization managed application step input.

Members
actionType
Required: Yes
Type: string

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

applicationId
Required: Yes
Type: string

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

listenerPort
Type: int

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

properties
Type: M2ManagedActionProperties structure

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

runtime
Required: Yes
Type: string

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

vpcEndpointServiceName
Type: string

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

M2ManagedApplicationStepOutput

Description

Specifies the AWS Mainframe Modernization managed application step output.

Members
importDataSetSummary
Type: Associative array of custom strings keys (String) to strings

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

M2ManagedApplicationStepSummary

Description

Specifies the AWS Mainframe Modernization managed application step summary.

Members
stepInput
Required: Yes
Type: M2ManagedApplicationStepInput structure

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

stepOutput
Type: M2ManagedApplicationStepOutput structure

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

M2ManagedApplicationSummary

Description

Specifies the AWS Mainframe Modernization managed application summary.

Members
applicationId
Required: Yes
Type: string

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

listenerPort
Type: int

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

runtime
Required: Yes
Type: string

The runtime of the AWS Mainframe Modernization managed application summary.

M2NonManagedApplication

Description

Specifies the AWS Mainframe Modernization non-managed application.

Members
listenerPort
Required: Yes
Type: string

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

runtime
Required: Yes
Type: string

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

vpcEndpointServiceName
Required: Yes
Type: string

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

webAppName
Type: string

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

M2NonManagedApplicationAction

Description

Specifies the AWS Mainframe Modernization non-managed application action.

Members
actionType
Required: Yes
Type: string

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

resource
Required: Yes
Type: string

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

M2NonManagedApplicationStepInput

Description

Specifies the AWS Mainframe Modernization non-managed application step input.

Members
actionType
Required: Yes
Type: string

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

listenerPort
Required: Yes
Type: int

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

runtime
Required: Yes
Type: string

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

vpcEndpointServiceName
Required: Yes
Type: string

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

webAppName
Type: string

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

M2NonManagedApplicationStepOutput

Description

Specifies the AWS Mainframe Modernization non-managed application step output.

Members

M2NonManagedApplicationStepSummary

Description

Specifies the AWS Mainframe Modernization non-managed application step summary.

Members
stepInput
Required: Yes
Type: M2NonManagedApplicationStepInput structure

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

stepOutput
Type: M2NonManagedApplicationStepOutput structure

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

M2NonManagedApplicationSummary

Description

Specifies the AWS Mainframe Modernization non-managed application summary.

Members
listenerPort
Required: Yes
Type: int

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

runtime
Required: Yes
Type: string

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

vpcEndpointServiceName
Required: Yes
Type: string

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

webAppName
Type: string

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

MainframeAction

Description

Specifies the mainframe action.

Members
actionType
Required: Yes
Type: MainframeActionType structure

The action type of the mainframe action.

properties
Type: MainframeActionProperties structure

The properties of the mainframe action.

resource
Required: Yes
Type: string

The resource of the mainframe action.

MainframeActionProperties

Description

Specifies the mainframe action properties.

Members
dmsTaskArn
Type: string

The DMS task ARN of the mainframe action properties.

MainframeActionSummary

Description

Specifies the mainframe action summary.

Members
batch
Type: BatchSummary structure

The batch of the mainframe action summary.

tn3270
Type: TN3270Summary structure

The tn3270 port of the mainframe action summary.

MainframeActionType

Description

Specifies the mainframe action type.

Members
batch
Type: Batch structure

The batch of the mainframe action type.

tn3270
Type: TN3270 structure

The tn3270 port of the mainframe action type.

MainframeResourceSummary

Description

Specifies the mainframe resource summary.

Members
m2ManagedApplication
Type: M2ManagedApplicationSummary structure

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

m2NonManagedApplication
Type: M2NonManagedApplicationSummary structure

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

Output

Description

Specifies an output.

Members
file
Type: OutputFile structure

The file of the output.

OutputFile

Description

Specifies an output file.

Members
fileLocation
Type: string

The file location of the output file.

Resource

Description

Specifies a resource.

Members
name
Required: Yes
Type: string

The name of the resource.

type
Required: Yes
Type: ResourceType structure

The type of the resource.

ResourceAction

Description

Specifies a resource action.

Members
cloudFormationAction
Type: CloudFormationAction structure

The CloudFormation action of the resource action.

m2ManagedApplicationAction
Type: M2ManagedApplicationAction structure

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

m2NonManagedApplicationAction
Type: M2NonManagedApplicationAction structure

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

ResourceActionSummary

Description

Specifies the resource action summary.

Members
cloudFormation
Type: CloudFormationStepSummary structure

The CloudFormation template of the resource action summary.

m2ManagedApplication
Type: M2ManagedApplicationStepSummary structure

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

m2NonManagedApplication
Type: M2NonManagedApplicationStepSummary structure

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

ResourceNotFoundException

Description

The specified resource was not found.

Members
message
Required: Yes
Type: string
resourceId
Type: string

The resource ID of the resource not found.

resourceType
Type: string

The resource type of the resource not found.

ResourceType

Description

Specifies the resource type.

Members
cloudFormation
Type: CloudFormation structure

The CloudFormation template of the resource type.

m2ManagedApplication
Type: M2ManagedApplication structure

The AWS Mainframe Modernization managed application of the resource type.

m2NonManagedApplication
Type: M2NonManagedApplication structure

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

Script

Description

Specifies the script.

Members
scriptLocation
Required: Yes
Type: string

The script location of the scripts.

type
Required: Yes
Type: string

The type of the scripts.

ScriptSummary

Description

Specifies the scripts summary.

Members
scriptLocation
Required: Yes
Type: string

The script location of the script summary.

type
Required: Yes
Type: string

The type of the script summary.

ServiceQuotaExceededException

Description

One or more quotas for AWS Application Testing exceeds the limit.

Members
message
Required: Yes
Type: string
quotaCode
Type: string

The quote codes of AWS Application Testing that exceeded the limit.

resourceId
Type: string

The resource ID of AWS Application Testing that exceeded the limit.

resourceType
Type: string

The resource type of AWS Application Testing that exceeded the limit.

serviceCode
Type: string

The service code of AWS Application Testing that exceeded the limit.

ServiceSettings

Description

Specifies the service settings.

Members
kmsKeyId
Type: string

The KMS key ID of the service settings.

SourceDatabaseMetadata

Description

Specifies the source database metadata.

Members
captureTool
Required: Yes
Type: string

The capture tool of the source database metadata.

type
Required: Yes
Type: string

The type of the source database metadata.

Step

Description

Defines a step.

Members
action
Required: Yes
Type: StepAction structure

The action of the step.

description
Type: string

The description of the step.

name
Required: Yes
Type: string

The name of the step.

StepAction

Description

Specifies a step action.

Members
compareAction
Type: CompareAction structure

The compare action of the step action.

mainframeAction
Type: MainframeAction structure

The mainframe action of the step action.

resourceAction
Type: ResourceAction structure

The resource action of the step action.

StepRunSummary

Description

Defines the step run summary.

Members
compareAction
Type: CompareActionSummary structure

The compare action of the step run summary.

mainframeAction
Type: MainframeActionSummary structure

The mainframe action of the step run summary.

resourceAction
Type: ResourceActionSummary structure

The resource action of the step run summary.

TN3270

Description

Specifies the TN3270 protocol.

Members
exportDataSetNames
Type: Array of strings

The data set names of the TN3270 protocol.

script
Required: Yes
Type: Script structure

The script of the TN3270 protocol.

TN3270StepInput

Description

Specifies a TN3270 step input.

Members
exportDataSetNames
Type: Array of strings

The export data set names of the TN3270 step input.

properties
Type: MainframeActionProperties structure

The properties of the TN3270 step input.

resource
Required: Yes
Type: MainframeResourceSummary structure

The resource of the TN3270 step input.

script
Required: Yes
Type: ScriptSummary structure

The script of the TN3270 step input.

TN3270StepOutput

Description

Specifies a TN3270 step output.

Members
dataSetDetails
Type: Array of DataSet structures

The data set details of the TN3270 step output.

dataSetExportLocation
Type: string

The data set export location of the TN3270 step output.

dmsOutputLocation
Type: string

The output location of the TN3270 step output.

scriptOutputLocation
Required: Yes
Type: string

The script output location of the TN3270 step output.

TN3270Summary

Description

Specifies a TN3270 summary.

Members
stepInput
Required: Yes
Type: TN3270StepInput structure

The step input of the TN3270 summary.

stepOutput
Type: TN3270StepOutput structure

The step output of the TN3270 summary.

TargetDatabaseMetadata

Description

Specifies a target database metadata.

Members
captureTool
Required: Yes
Type: string

The capture tool of the target database metadata.

type
Required: Yes
Type: string

The type of the target database metadata.

TestCaseLatestVersion

Description

Specifies the latest version of a test case.

Members
status
Required: Yes
Type: string

The status of the test case latest version.

statusReason
Type: string

The status reason of the test case latest version.

version
Required: Yes
Type: int

The version of the test case latest version.

TestCaseRunSummary

Description

Specifies the test case run summary.

Members
runEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run end time of the test case run summary.

runStartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run start time of the test case run summary.

status
Required: Yes
Type: string

The status of the test case run summary.

statusReason
Type: string

The status reason of the test case run summary.

testCaseId
Required: Yes
Type: string

The test case id of the test case run summary.

testCaseVersion
Required: Yes
Type: int

The test case version of the test case run summary.

testRunId
Required: Yes
Type: string

The test run id of the test case run summary.

TestCaseSummary

Description

Specifies a test case summary.

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test case summary.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test case summary.

latestVersion
Required: Yes
Type: int

The latest version of the test case summary.

name
Required: Yes
Type: string

The name of the test case summary.

status
Required: Yes
Type: string

The status of the test case summary.

statusReason
Type: string

The status reason of the test case summary.

testCaseArn
Required: Yes
Type: string

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

testCaseId
Required: Yes
Type: string

The test case ID of the test case summary.

TestCases

Description

Specifies test cases.

Members
sequential
Type: Array of strings

The sequential of the test case.

TestConfigurationLatestVersion

Description

Specifies the latest version of the test configuration.

Members
status
Required: Yes
Type: string

The status of the test configuration latest version.

statusReason
Type: string

The status reason of the test configuration latest version.

version
Required: Yes
Type: int

The version of the test configuration latest version.

TestConfigurationSummary

Description

Specifies a test configuration summary.

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test configuration summary.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test configuration summary.

latestVersion
Required: Yes
Type: int

The latest version of the test configuration summary.

name
Required: Yes
Type: string

The name of the test configuration summary.

status
Required: Yes
Type: string

The status of the test configuration summary.

statusReason
Type: string

The status reason of the test configuration summary.

testConfigurationArn
Required: Yes
Type: string

The test configuration ARN of the test configuration summary.

testConfigurationId
Required: Yes
Type: string

The test configuration ID of the test configuration summary.

TestRunStepSummary

Description

Specifies a test run step summary.

Members
afterStep
Type: boolean

The after step of the test run step summary.

beforeStep
Type: boolean

The before step of the test run step summary.

runEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run end time of the test run step summary.

runStartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run start time of the test run step summary.

status
Required: Yes
Type: string

The status of the test run step summary.

statusReason
Type: string

The status reason of the test run step summary.

stepName
Required: Yes
Type: string

The step name of the test run step summary.

testCaseId
Type: string

The test case ID of the test run step summary.

testCaseVersion
Type: int

The test case version of the test run step summary.

testRunId
Required: Yes
Type: string

The test run ID of the test run step summary.

testSuiteId
Type: string

The test suite ID of the test run step summary.

testSuiteVersion
Type: int

The test suite version of the test run step summary.

TestRunSummary

Description

Specifies a test run summary.

Members
runEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run end time of the test run summary.

runStartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The run start time of the test run summary.

status
Required: Yes
Type: string

The status of the test run summary.

statusReason
Type: string

The status reason of the test run summary.

testConfigurationId
Type: string

The test configuration ID of the test run summary.

testConfigurationVersion
Type: int

The test configuration version of the test run summary.

testRunArn
Required: Yes
Type: string

The test run ARN of the test run summary.

testRunId
Required: Yes
Type: string

The test run ID of the test run summary.

testSuiteId
Required: Yes
Type: string

The test suite ID of the test run summary.

testSuiteVersion
Required: Yes
Type: int

The test suite version of the test run summary.

TestSuiteLatestVersion

Description

Specifies the latest version of a test suite.

Members
status
Required: Yes
Type: string

The status of the test suite latest version.

statusReason
Type: string

The status reason of the test suite latest version.

version
Required: Yes
Type: int

The version of the test suite latest version.

TestSuiteSummary

Description

Specifies the test suite summary.

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the test suite summary.

lastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the test suite summary.

latestVersion
Required: Yes
Type: int

The latest version of the test suite summary.

name
Required: Yes
Type: string

The name of the test suite summary.

status
Required: Yes
Type: string

The status of the test suite summary.

statusReason
Type: string

The status reason of the test suite summary.

testSuiteArn
Required: Yes
Type: string

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

testSuiteId
Required: Yes
Type: string

The test suite ID of the test suite summary.

ThrottlingException

Description

The number of requests made exceeds the limit.

Members
message
Required: Yes
Type: string
quotaCode
Type: string

The quota code of requests that exceed the limit.

retryAfterSeconds
Type: int

The number of seconds to retry after for requests that exceed the limit.

serviceCode
Type: string

The service code of requests that exceed the limit.

ValidationException

Description

One or more parameter provided in the request is not valid.

Members
fieldList
Type: Array of ValidationExceptionField structures

The field list of the validation exception.

message
Required: Yes
Type: string
reason
Type: string

The reason for the validation exception.

ValidationExceptionField

Description

Specifies a validation exception field.

Members
message
Required: Yes
Type: string

The message stating reason for why service validation failed.

name
Required: Yes
Type: string

The name of the validation exception field.