Skip to content

MainframeModernizationApplicationTestingClient#

Index > MainframeModernizationApplicationTesting > MainframeModernizationApplicationTestingClient

Auto-generated documentation for MainframeModernizationApplicationTesting type annotations stubs module mypy-boto3-apptest.

MainframeModernizationApplicationTestingClient#

Type annotations and code completion for boto3.client("apptest"). boto3 documentation

# MainframeModernizationApplicationTestingClient usage example

from boto3.session import Session
from mypy_boto3_apptest.client import MainframeModernizationApplicationTestingClient

def get_apptest_client() -> MainframeModernizationApplicationTestingClient:
    return Session().client("apptest")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("apptest").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("apptest")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_apptest.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("apptest").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("apptest").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_test_case#

Creates a test case.

Type annotations and code completion for boto3.client("apptest").create_test_case method. boto3 documentation

# create_test_case method definition

def create_test_case(
    self,
    *,
    name: str,
    steps: Sequence[StepUnionTypeDef],  # (1)
    description: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTestCaseResponseTypeDef:  # (2)
    ...
  1. See StepTypeDef StepOutputTypeDef
  2. See CreateTestCaseResponseTypeDef 
# create_test_case method usage example with argument unpacking

kwargs: CreateTestCaseRequestRequestTypeDef = {  # (1)
    "name": ...,
    "steps": ...,
}

parent.create_test_case(**kwargs)
  1. See CreateTestCaseRequestRequestTypeDef

create_test_configuration#

Creates a test configuration.

Type annotations and code completion for boto3.client("apptest").create_test_configuration method. boto3 documentation

# create_test_configuration method definition

def create_test_configuration(
    self,
    *,
    name: str,
    resources: Sequence[ResourceUnionTypeDef],  # (1)
    description: str = ...,
    properties: Mapping[str, str] = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    serviceSettings: ServiceSettingsTypeDef = ...,  # (2)
) -> CreateTestConfigurationResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeDef ResourceOutputTypeDef
  2. See ServiceSettingsTypeDef
  3. See CreateTestConfigurationResponseTypeDef 
# create_test_configuration method usage example with argument unpacking

kwargs: CreateTestConfigurationRequestRequestTypeDef = {  # (1)
    "name": ...,
    "resources": ...,
}

parent.create_test_configuration(**kwargs)
  1. See CreateTestConfigurationRequestRequestTypeDef

create_test_suite#

Creates a test suite.

Type annotations and code completion for boto3.client("apptest").create_test_suite method. boto3 documentation

# create_test_suite method definition

def create_test_suite(
    self,
    *,
    name: str,
    testCases: TestCasesTypeDef,  # (1)
    description: str = ...,
    beforeSteps: Sequence[StepTypeDef] = ...,  # (2)
    afterSteps: Sequence[StepTypeDef] = ...,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTestSuiteResponseTypeDef:  # (4)
    ...
  1. See TestCasesTypeDef
  2. See StepTypeDef
  3. See StepTypeDef
  4. See CreateTestSuiteResponseTypeDef 
# create_test_suite method usage example with argument unpacking

kwargs: CreateTestSuiteRequestRequestTypeDef = {  # (1)
    "name": ...,
    "testCases": ...,
}

parent.create_test_suite(**kwargs)
  1. See CreateTestSuiteRequestRequestTypeDef

delete_test_case#

Deletes a test case.

Type annotations and code completion for boto3.client("apptest").delete_test_case method. boto3 documentation

# delete_test_case method definition

def delete_test_case(
    self,
    *,
    testCaseId: str,
) -> Dict[str, Any]:
    ...
# delete_test_case method usage example with argument unpacking

kwargs: DeleteTestCaseRequestRequestTypeDef = {  # (1)
    "testCaseId": ...,
}

parent.delete_test_case(**kwargs)
  1. See DeleteTestCaseRequestRequestTypeDef

delete_test_configuration#

Deletes a test configuration.

Type annotations and code completion for boto3.client("apptest").delete_test_configuration method. boto3 documentation

# delete_test_configuration method definition

def delete_test_configuration(
    self,
    *,
    testConfigurationId: str,
) -> Dict[str, Any]:
    ...
# delete_test_configuration method usage example with argument unpacking

kwargs: DeleteTestConfigurationRequestRequestTypeDef = {  # (1)
    "testConfigurationId": ...,
}

parent.delete_test_configuration(**kwargs)
  1. See DeleteTestConfigurationRequestRequestTypeDef

delete_test_run#

Deletes a test run.

Type annotations and code completion for boto3.client("apptest").delete_test_run method. boto3 documentation

# delete_test_run method definition

def delete_test_run(
    self,
    *,
    testRunId: str,
) -> Dict[str, Any]:
    ...
# delete_test_run method usage example with argument unpacking

kwargs: DeleteTestRunRequestRequestTypeDef = {  # (1)
    "testRunId": ...,
}

parent.delete_test_run(**kwargs)
  1. See DeleteTestRunRequestRequestTypeDef

delete_test_suite#

Deletes a test suite.

Type annotations and code completion for boto3.client("apptest").delete_test_suite method. boto3 documentation

# delete_test_suite method definition

def delete_test_suite(
    self,
    *,
    testSuiteId: str,
) -> Dict[str, Any]:
    ...
# delete_test_suite method usage example with argument unpacking

kwargs: DeleteTestSuiteRequestRequestTypeDef = {  # (1)
    "testSuiteId": ...,
}

parent.delete_test_suite(**kwargs)
  1. See DeleteTestSuiteRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("apptest").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_test_case#

Gets a test case.

Type annotations and code completion for boto3.client("apptest").get_test_case method. boto3 documentation

# get_test_case method definition

def get_test_case(
    self,
    *,
    testCaseId: str,
    testCaseVersion: int = ...,
) -> GetTestCaseResponseTypeDef:  # (1)
    ...
  1. See GetTestCaseResponseTypeDef 
# get_test_case method usage example with argument unpacking

kwargs: GetTestCaseRequestRequestTypeDef = {  # (1)
    "testCaseId": ...,
}

parent.get_test_case(**kwargs)
  1. See GetTestCaseRequestRequestTypeDef

get_test_configuration#

Gets a test configuration.

Type annotations and code completion for boto3.client("apptest").get_test_configuration method. boto3 documentation

# get_test_configuration method definition

def get_test_configuration(
    self,
    *,
    testConfigurationId: str,
    testConfigurationVersion: int = ...,
) -> GetTestConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetTestConfigurationResponseTypeDef 
# get_test_configuration method usage example with argument unpacking

kwargs: GetTestConfigurationRequestRequestTypeDef = {  # (1)
    "testConfigurationId": ...,
}

parent.get_test_configuration(**kwargs)
  1. See GetTestConfigurationRequestRequestTypeDef

get_test_run_step#

Gets a test run step.

Type annotations and code completion for boto3.client("apptest").get_test_run_step method. boto3 documentation

# get_test_run_step method definition

def get_test_run_step(
    self,
    *,
    testRunId: str,
    stepName: str,
    testCaseId: str = ...,
    testSuiteId: str = ...,
) -> GetTestRunStepResponseTypeDef:  # (1)
    ...
  1. See GetTestRunStepResponseTypeDef 
# get_test_run_step method usage example with argument unpacking

kwargs: GetTestRunStepRequestRequestTypeDef = {  # (1)
    "testRunId": ...,
    "stepName": ...,
}

parent.get_test_run_step(**kwargs)
  1. See GetTestRunStepRequestRequestTypeDef

get_test_suite#

Gets a test suite.

Type annotations and code completion for boto3.client("apptest").get_test_suite method. boto3 documentation

# get_test_suite method definition

def get_test_suite(
    self,
    *,
    testSuiteId: str,
    testSuiteVersion: int = ...,
) -> GetTestSuiteResponseTypeDef:  # (1)
    ...
  1. See GetTestSuiteResponseTypeDef 
# get_test_suite method usage example with argument unpacking

kwargs: GetTestSuiteRequestRequestTypeDef = {  # (1)
    "testSuiteId": ...,
}

parent.get_test_suite(**kwargs)
  1. See GetTestSuiteRequestRequestTypeDef

list_tags_for_resource#

Lists tags for a resource.

Type annotations and code completion for boto3.client("apptest").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_test_cases#

Lists test cases.

Type annotations and code completion for boto3.client("apptest").list_test_cases method. boto3 documentation

# list_test_cases method definition

def list_test_cases(
    self,
    *,
    testCaseIds: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestCasesResponseTypeDef:  # (1)
    ...
  1. See ListTestCasesResponseTypeDef 
# list_test_cases method usage example with argument unpacking

kwargs: ListTestCasesRequestRequestTypeDef = {  # (1)
    "testCaseIds": ...,
}

parent.list_test_cases(**kwargs)
  1. See ListTestCasesRequestRequestTypeDef

list_test_configurations#

Lists test configurations.

Type annotations and code completion for boto3.client("apptest").list_test_configurations method. boto3 documentation

# list_test_configurations method definition

def list_test_configurations(
    self,
    *,
    testConfigurationIds: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListTestConfigurationsResponseTypeDef 
# list_test_configurations method usage example with argument unpacking

kwargs: ListTestConfigurationsRequestRequestTypeDef = {  # (1)
    "testConfigurationIds": ...,
}

parent.list_test_configurations(**kwargs)
  1. See ListTestConfigurationsRequestRequestTypeDef

list_test_run_steps#

Lists test run steps.

Type annotations and code completion for boto3.client("apptest").list_test_run_steps method. boto3 documentation

# list_test_run_steps method definition

def list_test_run_steps(
    self,
    *,
    testRunId: str,
    testCaseId: str = ...,
    testSuiteId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestRunStepsResponseTypeDef:  # (1)
    ...
  1. See ListTestRunStepsResponseTypeDef 
# list_test_run_steps method usage example with argument unpacking

kwargs: ListTestRunStepsRequestRequestTypeDef = {  # (1)
    "testRunId": ...,
}

parent.list_test_run_steps(**kwargs)
  1. See ListTestRunStepsRequestRequestTypeDef

list_test_run_test_cases#

Lists test run test cases.

Type annotations and code completion for boto3.client("apptest").list_test_run_test_cases method. boto3 documentation

# list_test_run_test_cases method definition

def list_test_run_test_cases(
    self,
    *,
    testRunId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestRunTestCasesResponseTypeDef:  # (1)
    ...
  1. See ListTestRunTestCasesResponseTypeDef 
# list_test_run_test_cases method usage example with argument unpacking

kwargs: ListTestRunTestCasesRequestRequestTypeDef = {  # (1)
    "testRunId": ...,
}

parent.list_test_run_test_cases(**kwargs)
  1. See ListTestRunTestCasesRequestRequestTypeDef

list_test_runs#

Lists test runs.

Type annotations and code completion for boto3.client("apptest").list_test_runs method. boto3 documentation

# list_test_runs method definition

def list_test_runs(
    self,
    *,
    testSuiteId: str = ...,
    testRunIds: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestRunsResponseTypeDef:  # (1)
    ...
  1. See ListTestRunsResponseTypeDef 
# list_test_runs method usage example with argument unpacking

kwargs: ListTestRunsRequestRequestTypeDef = {  # (1)
    "testSuiteId": ...,
}

parent.list_test_runs(**kwargs)
  1. See ListTestRunsRequestRequestTypeDef

list_test_suites#

Lists test suites.

Type annotations and code completion for boto3.client("apptest").list_test_suites method. boto3 documentation

# list_test_suites method definition

def list_test_suites(
    self,
    *,
    testSuiteIds: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTestSuitesResponseTypeDef:  # (1)
    ...
  1. See ListTestSuitesResponseTypeDef 
# list_test_suites method usage example with argument unpacking

kwargs: ListTestSuitesRequestRequestTypeDef = {  # (1)
    "testSuiteIds": ...,
}

parent.list_test_suites(**kwargs)
  1. See ListTestSuitesRequestRequestTypeDef

start_test_run#

Starts a test run.

Type annotations and code completion for boto3.client("apptest").start_test_run method. boto3 documentation

# start_test_run method definition

def start_test_run(
    self,
    *,
    testSuiteId: str,
    testConfigurationId: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> StartTestRunResponseTypeDef:  # (1)
    ...
  1. See StartTestRunResponseTypeDef 
# start_test_run method usage example with argument unpacking

kwargs: StartTestRunRequestRequestTypeDef = {  # (1)
    "testSuiteId": ...,
}

parent.start_test_run(**kwargs)
  1. See StartTestRunRequestRequestTypeDef

tag_resource#

Specifies tags of a resource.

Type annotations and code completion for boto3.client("apptest").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Untags a resource.

Type annotations and code completion for boto3.client("apptest").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_test_case#

Updates a test case.

Type annotations and code completion for boto3.client("apptest").update_test_case method. boto3 documentation

# update_test_case method definition

def update_test_case(
    self,
    *,
    testCaseId: str,
    description: str = ...,
    steps: Sequence[StepTypeDef] = ...,  # (1)
) -> UpdateTestCaseResponseTypeDef:  # (2)
    ...
  1. See StepTypeDef
  2. See UpdateTestCaseResponseTypeDef 
# update_test_case method usage example with argument unpacking

kwargs: UpdateTestCaseRequestRequestTypeDef = {  # (1)
    "testCaseId": ...,
}

parent.update_test_case(**kwargs)
  1. See UpdateTestCaseRequestRequestTypeDef

update_test_configuration#

Updates a test configuration.

Type annotations and code completion for boto3.client("apptest").update_test_configuration method. boto3 documentation

# update_test_configuration method definition

def update_test_configuration(
    self,
    *,
    testConfigurationId: str,
    description: str = ...,
    resources: Sequence[ResourceTypeDef] = ...,  # (1)
    properties: Mapping[str, str] = ...,
    serviceSettings: ServiceSettingsTypeDef = ...,  # (2)
) -> UpdateTestConfigurationResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeDef
  2. See ServiceSettingsTypeDef
  3. See UpdateTestConfigurationResponseTypeDef 
# update_test_configuration method usage example with argument unpacking

kwargs: UpdateTestConfigurationRequestRequestTypeDef = {  # (1)
    "testConfigurationId": ...,
}

parent.update_test_configuration(**kwargs)
  1. See UpdateTestConfigurationRequestRequestTypeDef

update_test_suite#

Updates a test suite.

Type annotations and code completion for boto3.client("apptest").update_test_suite method. boto3 documentation

# update_test_suite method definition

def update_test_suite(
    self,
    *,
    testSuiteId: str,
    description: str = ...,
    beforeSteps: Sequence[StepTypeDef] = ...,  # (1)
    afterSteps: Sequence[StepTypeDef] = ...,  # (1)
    testCases: TestCasesTypeDef = ...,  # (3)
) -> UpdateTestSuiteResponseTypeDef:  # (4)
    ...
  1. See StepTypeDef
  2. See StepTypeDef
  3. See TestCasesTypeDef
  4. See UpdateTestSuiteResponseTypeDef 
# update_test_suite method usage example with argument unpacking

kwargs: UpdateTestSuiteRequestRequestTypeDef = {  # (1)
    "testSuiteId": ...,
}

parent.update_test_suite(**kwargs)
  1. See UpdateTestSuiteRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("apptest").get_paginator method with overloads.