Apptest
This page documents function available when using the Apptest module, created with @service Apptest.
Index
Main.Apptest.create_test_caseMain.Apptest.create_test_configurationMain.Apptest.create_test_suiteMain.Apptest.delete_test_caseMain.Apptest.delete_test_configurationMain.Apptest.delete_test_runMain.Apptest.delete_test_suiteMain.Apptest.get_test_caseMain.Apptest.get_test_configurationMain.Apptest.get_test_run_stepMain.Apptest.get_test_suiteMain.Apptest.list_tags_for_resourceMain.Apptest.list_test_casesMain.Apptest.list_test_configurationsMain.Apptest.list_test_run_stepsMain.Apptest.list_test_run_test_casesMain.Apptest.list_test_runsMain.Apptest.list_test_suitesMain.Apptest.start_test_runMain.Apptest.tag_resourceMain.Apptest.untag_resourceMain.Apptest.update_test_caseMain.Apptest.update_test_configurationMain.Apptest.update_test_suite
Documentation
Main.Apptest.create_test_case — Methodcreate_test_case(name, steps)
create_test_case(name, steps, params::Dict{String,<:Any})Creates a test case.
Arguments
name: The name of the test case.steps: The steps in the test case.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"clientToken": The client token of the test case."description": The description of the test case."tags": The specified tags of the test case.
Main.Apptest.create_test_configuration — Methodcreate_test_configuration(name, resources)
create_test_configuration(name, resources, params::Dict{String,<:Any})Creates a test configuration.
Arguments
name: The name of the test configuration.resources: The defined resources of the test configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"clientToken": The client token of the test configuration."description": The description of the test configuration."properties": The properties of the test configuration."serviceSettings": The service settings of the test configuration."tags": The tags of the test configuration.
Main.Apptest.create_test_suite — Methodcreate_test_suite(name, test_cases)
create_test_suite(name, test_cases, params::Dict{String,<:Any})Creates a test suite.
Arguments
name: The name of the test suite.test_cases: The test cases in the test suite.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"afterSteps": The after steps of the test suite."beforeSteps": The before steps of the test suite."clientToken": The client token of the test suite."description": The description of the test suite."tags": The tags of the test suite.
Main.Apptest.delete_test_case — Methoddelete_test_case(test_case_id)
delete_test_case(test_case_id, params::Dict{String,<:Any})Deletes a test case.
Arguments
test_case_id: The test case ID of the test case.
Main.Apptest.delete_test_configuration — Methoddelete_test_configuration(test_configuration_id)
delete_test_configuration(test_configuration_id, params::Dict{String,<:Any})Deletes a test configuration.
Arguments
test_configuration_id: The test ID of the test configuration.
Main.Apptest.delete_test_run — Methoddelete_test_run(test_run_id)
delete_test_run(test_run_id, params::Dict{String,<:Any})Deletes a test run.
Arguments
test_run_id: The run ID of the test run.
Main.Apptest.delete_test_suite — Methoddelete_test_suite(test_suite_id)
delete_test_suite(test_suite_id, params::Dict{String,<:Any})Deletes a test suite.
Arguments
test_suite_id: The test ID of the test suite.
Main.Apptest.get_test_case — Methodget_test_case(test_case_id)
get_test_case(test_case_id, params::Dict{String,<:Any})Gets a test case.
Arguments
test_case_id: The request test ID of the test case.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"testCaseVersion": The test case version of the test case.
Main.Apptest.get_test_configuration — Methodget_test_configuration(test_configuration_id)
get_test_configuration(test_configuration_id, params::Dict{String,<:Any})Gets a test configuration.
Arguments
test_configuration_id: The request test configuration ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"testConfigurationVersion": The test configuration version.
Main.Apptest.get_test_run_step — Methodget_test_run_step(step_name, test_run_id)
get_test_run_step(step_name, test_run_id, params::Dict{String,<:Any})Gets a test run step.
Arguments
step_name: The step name of the test run step.test_run_id: The test run ID of the test run step.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"testCaseId": The test case ID of a test run step."testSuiteId": The test suite ID of a test run step.
Main.Apptest.get_test_suite — Methodget_test_suite(test_suite_id)
get_test_suite(test_suite_id, params::Dict{String,<:Any})Gets a test suite.
Arguments
test_suite_id: The ID of the test suite.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"testSuiteVersion": The version of the test suite.
Main.Apptest.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists tags for a resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Apptest.list_test_cases — Methodlist_test_cases()
list_test_cases(params::Dict{String,<:Any})Lists test cases.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum results of the test case."nextToken": The next token of the test cases."testCaseIds": The IDs of the test cases.
Main.Apptest.list_test_configurations — Methodlist_test_configurations()
list_test_configurations(params::Dict{String,<:Any})Lists test configurations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum results of the test configuration."nextToken": The next token for the test configurations."testConfigurationIds": The configuration IDs of the test configurations.
Main.Apptest.list_test_run_steps — Methodlist_test_run_steps(test_run_id)
list_test_run_steps(test_run_id, params::Dict{String,<:Any})Lists test run steps.
Arguments
test_run_id: The test run ID of the test run steps.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of test run steps to return in one page of results."nextToken": The token from a previous step to retrieve the next page of results."testCaseId": The test case ID of the test run steps."testSuiteId": The test suite ID of the test run steps.
Main.Apptest.list_test_run_test_cases — Methodlist_test_run_test_cases(test_run_id)
list_test_run_test_cases(test_run_id, params::Dict{String,<:Any})Lists test run test cases.
Arguments
test_run_id: The test run ID of the test cases.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of test run test cases to return in one page of results."nextToken": The token from a previous request to retrieve the next page of results.
Main.Apptest.list_test_runs — Methodlist_test_runs()
list_test_runs(params::Dict{String,<:Any})Lists test runs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of test runs to return in one page of results."nextToken": The token from the previous request to retrieve the next page of test run results."testSuiteId": The test suite ID of the test runs."testrunIds": The test run IDs of the test runs.
Main.Apptest.list_test_suites — Methodlist_test_suites()
list_test_suites(params::Dict{String,<:Any})Lists test suites.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of test suites to return in one page of results."nextToken": The token from a previous request to retrieve the next page of results."testSuiteIds": The suite ID of the test suites.
Main.Apptest.start_test_run — Methodstart_test_run(test_suite_id)
start_test_run(test_suite_id, params::Dict{String,<:Any})Starts a test run.
Arguments
test_suite_id: The test suite ID of the test run.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"clientToken": The client token of the test run."tags": The tags of the test run."testConfigurationId": The configuration ID of the test run.
Main.Apptest.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Specifies tags of a resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the tag resource.tags: The tags of the resource.
Main.Apptest.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Untags a resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tag_keys: The tag keys of the resource.
Main.Apptest.update_test_case — Methodupdate_test_case(test_case_id)
update_test_case(test_case_id, params::Dict{String,<:Any})Updates a test case.
Arguments
test_case_id: The test case ID of the test case.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": The description of the test case."steps": The steps of the test case.
Main.Apptest.update_test_configuration — Methodupdate_test_configuration(test_configuration_id)
update_test_configuration(test_configuration_id, params::Dict{String,<:Any})Updates a test configuration.
Arguments
test_configuration_id: The test configuration ID of the test configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": The description of the test configuration."properties": The properties of the test configuration."resources": The resources of the test configuration."serviceSettings": The service settings of the test configuration.
Main.Apptest.update_test_suite — Methodupdate_test_suite(test_suite_id)
update_test_suite(test_suite_id, params::Dict{String,<:Any})Updates a test suite.
Arguments
test_suite_id: The test suite ID of the test suite.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"afterSteps": The after steps of the test suite."beforeSteps": The before steps for the test suite."description": The description of the test suite."testCases": The test cases in the test suite.