com.amazonaws.services.apptest.AWSAppTest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-apptest Show documentation
Show all versions of aws-java-sdk-apptest Show documentation
The AWS Java SDK for AWS Mainframe Modernization Application Testing module holds the client classes that are used for communicating with AWS Mainframe Modernization Application Testing Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.apptest;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.apptest.model.*;
/**
* Interface for accessing AWS Mainframe Modernization Application Testing.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.apptest.AbstractAWSAppTest} instead.
*
*
*
* AWS Mainframe Modernization Application Testing provides tools and resources for automated functional equivalence
* testing for your migration projects.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppTest {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "apptest";
/**
*
* Creates a test case.
*
*
* @param createTestCaseRequest
* @return Result of the CreateTestCase operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.CreateTestCase
* @see AWS API
* Documentation
*/
CreateTestCaseResult createTestCase(CreateTestCaseRequest createTestCaseRequest);
/**
*
* Creates a test configuration.
*
*
* @param createTestConfigurationRequest
* @return Result of the CreateTestConfiguration operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.CreateTestConfiguration
* @see AWS API Documentation
*/
CreateTestConfigurationResult createTestConfiguration(CreateTestConfigurationRequest createTestConfigurationRequest);
/**
*
* Creates a test suite.
*
*
* @param createTestSuiteRequest
* @return Result of the CreateTestSuite operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.CreateTestSuite
* @see AWS API
* Documentation
*/
CreateTestSuiteResult createTestSuite(CreateTestSuiteRequest createTestSuiteRequest);
/**
*
* Deletes a test case.
*
*
* @param deleteTestCaseRequest
* @return Result of the DeleteTestCase operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.DeleteTestCase
* @see AWS API
* Documentation
*/
DeleteTestCaseResult deleteTestCase(DeleteTestCaseRequest deleteTestCaseRequest);
/**
*
* Deletes a test configuration.
*
*
* @param deleteTestConfigurationRequest
* @return Result of the DeleteTestConfiguration operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.DeleteTestConfiguration
* @see AWS API Documentation
*/
DeleteTestConfigurationResult deleteTestConfiguration(DeleteTestConfigurationRequest deleteTestConfigurationRequest);
/**
*
* Deletes a test run.
*
*
* @param deleteTestRunRequest
* @return Result of the DeleteTestRun operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.DeleteTestRun
* @see AWS API
* Documentation
*/
DeleteTestRunResult deleteTestRun(DeleteTestRunRequest deleteTestRunRequest);
/**
*
* Deletes a test suite.
*
*
* @param deleteTestSuiteRequest
* @return Result of the DeleteTestSuite operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.DeleteTestSuite
* @see AWS API
* Documentation
*/
DeleteTestSuiteResult deleteTestSuite(DeleteTestSuiteRequest deleteTestSuiteRequest);
/**
*
* Gets a test case.
*
*
* @param getTestCaseRequest
* @return Result of the GetTestCase operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.GetTestCase
* @see AWS API
* Documentation
*/
GetTestCaseResult getTestCase(GetTestCaseRequest getTestCaseRequest);
/**
*
* Gets a test configuration.
*
*
* @param getTestConfigurationRequest
* @return Result of the GetTestConfiguration operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.GetTestConfiguration
* @see AWS
* API Documentation
*/
GetTestConfigurationResult getTestConfiguration(GetTestConfigurationRequest getTestConfigurationRequest);
/**
*
* Gets a test run step.
*
*
* @param getTestRunStepRequest
* @return Result of the GetTestRunStep operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.GetTestRunStep
* @see AWS API
* Documentation
*/
GetTestRunStepResult getTestRunStep(GetTestRunStepRequest getTestRunStepRequest);
/**
*
* Gets a test suite.
*
*
* @param getTestSuiteRequest
* @return Result of the GetTestSuite operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.GetTestSuite
* @see AWS API
* Documentation
*/
GetTestSuiteResult getTestSuite(GetTestSuiteRequest getTestSuiteRequest);
/**
*
* Lists tags for a resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists test cases.
*
*
* @param listTestCasesRequest
* @return Result of the ListTestCases operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestCases
* @see AWS API
* Documentation
*/
ListTestCasesResult listTestCases(ListTestCasesRequest listTestCasesRequest);
/**
*
* Lists test configurations.
*
*
* @param listTestConfigurationsRequest
* @return Result of the ListTestConfigurations operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestConfigurations
* @see AWS
* API Documentation
*/
ListTestConfigurationsResult listTestConfigurations(ListTestConfigurationsRequest listTestConfigurationsRequest);
/**
*
* Lists test run steps.
*
*
* @param listTestRunStepsRequest
* @return Result of the ListTestRunSteps operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestRunSteps
* @see AWS API
* Documentation
*/
ListTestRunStepsResult listTestRunSteps(ListTestRunStepsRequest listTestRunStepsRequest);
/**
*
* Lists test run test cases.
*
*
* @param listTestRunTestCasesRequest
* @return Result of the ListTestRunTestCases operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestRunTestCases
* @see AWS
* API Documentation
*/
ListTestRunTestCasesResult listTestRunTestCases(ListTestRunTestCasesRequest listTestRunTestCasesRequest);
/**
*
* Lists test runs.
*
*
* @param listTestRunsRequest
* @return Result of the ListTestRuns operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestRuns
* @see AWS API
* Documentation
*/
ListTestRunsResult listTestRuns(ListTestRunsRequest listTestRunsRequest);
/**
*
* Lists test suites.
*
*
* @param listTestSuitesRequest
* @return Result of the ListTestSuites operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.ListTestSuites
* @see AWS API
* Documentation
*/
ListTestSuitesResult listTestSuites(ListTestSuitesRequest listTestSuitesRequest);
/**
*
* Starts a test run.
*
*
* @param startTestRunRequest
* @return Result of the StartTestRun operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.StartTestRun
* @see AWS API
* Documentation
*/
StartTestRunResult startTestRun(StartTestRunRequest startTestRunRequest);
/**
*
* Specifies tags of a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ServiceQuotaExceededException
* One or more quotas for AWS Application Testing exceeds the limit.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Untags a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a test case.
*
*
* @param updateTestCaseRequest
* @return Result of the UpdateTestCase operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.UpdateTestCase
* @see AWS API
* Documentation
*/
UpdateTestCaseResult updateTestCase(UpdateTestCaseRequest updateTestCaseRequest);
/**
*
* Updates a test configuration.
*
*
* @param updateTestConfigurationRequest
* @return Result of the UpdateTestConfiguration operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.UpdateTestConfiguration
* @see AWS API Documentation
*/
UpdateTestConfigurationResult updateTestConfiguration(UpdateTestConfigurationRequest updateTestConfigurationRequest);
/**
*
* Updates a test suite.
*
*
* @param updateTestSuiteRequest
* @return Result of the UpdateTestSuite operation returned by the service.
* @throws ThrottlingException
* The number of requests made exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* The account or role doesn't have the right permissions to make the request.
* @throws ValidationException
* One or more parameter provided in the request is not valid.
* @throws ConflictException
* The parameters provided in the request conflict with existing resources.
* @throws InternalServerException
* An unexpected error occurred during the processing of the request.
* @sample AWSAppTest.UpdateTestSuite
* @see AWS API
* Documentation
*/
UpdateTestSuiteResult updateTestSuite(UpdateTestSuiteRequest updateTestSuiteRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}