Class: Aws::AppTest::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::AppTest::Client

Includes:

ClientStubs

Defined in:

lib/aws-sdk-apptest/client.rb

Overview

An API client for AppTest. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::AppTest::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary

• .identifier ⇒ Object readonly private

API Operations

• #create_test_case(params = {}) ⇒ Types::CreateTestCaseResponse

  Creates a test case.

• #create_test_configuration(params = {}) ⇒ Types::CreateTestConfigurationResponse

  Creates a test configuration.

• #create_test_suite(params = {}) ⇒ Types::CreateTestSuiteResponse

  Creates a test suite.

• #delete_test_case(params = {}) ⇒ Struct

  Deletes a test case.

• #delete_test_configuration(params = {}) ⇒ Struct

  Deletes a test configuration.

• #delete_test_run(params = {}) ⇒ Struct

  Deletes a test run.

• #delete_test_suite(params = {}) ⇒ Struct

  Deletes a test suite.

• #get_test_case(params = {}) ⇒ Types::GetTestCaseResponse

  Gets a test case.

• #get_test_configuration(params = {}) ⇒ Types::GetTestConfigurationResponse

  Gets a test configuration.

• #get_test_run_step(params = {}) ⇒ Types::GetTestRunStepResponse

  Gets a test run step.

• #get_test_suite(params = {}) ⇒ Types::GetTestSuiteResponse

  Gets a test suite.

• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

  Lists tags for a resource.

• #list_test_cases(params = {}) ⇒ Types::ListTestCasesResponse

  Lists test cases.

• #list_test_configurations(params = {}) ⇒ Types::ListTestConfigurationsResponse

  Lists test configurations.

• #list_test_run_steps(params = {}) ⇒ Types::ListTestRunStepsResponse

  Lists test run steps.

• #list_test_run_test_cases(params = {}) ⇒ Types::ListTestRunTestCasesResponse

  Lists test run test cases.

• #list_test_runs(params = {}) ⇒ Types::ListTestRunsResponse

  Lists test runs.

• #list_test_suites(params = {}) ⇒ Types::ListTestSuitesResponse

  Lists test suites.

• #start_test_run(params = {}) ⇒ Types::StartTestRunResponse

  Starts a test run.

• #tag_resource(params = {}) ⇒ Struct

  Specifies tags of a resource.

• #untag_resource(params = {}) ⇒ Struct

  Untags a resource.

• #update_test_case(params = {}) ⇒ Types::UpdateTestCaseResponse

  Updates a test case.

• #update_test_configuration(params = {}) ⇒ Types::UpdateTestConfigurationResponse

  Updates a test configuration.

• #update_test_suite(params = {}) ⇒ Types::UpdateTestSuiteResponse

  Updates a test suite.

Class Method Summary

• .errors_module ⇒ Object private

Instance Method Summary

• #build_request(operation_name, params = {}) ⇒ Object private
• #initialize(options) ⇒ Client constructor

  A new instance of Client.

• #waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

• :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

  A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

• :credentials (required, Aws::CredentialProvider) —

  Your AWS credentials. This can be an instance of any one of the following classes:

  • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

  • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

  • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

  • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

  • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

  • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

  • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

  • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

  When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

  • ‘Aws.config`

  • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

  • ENV, ENV, ENV, and ENV

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

  • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

• :region (required, String) —

  The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • ‘Aws.config`

  • ‘ENV`

  • ‘ENV`

  • ‘ENV`

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

• :access_key_id (String)
• :account_id (String)
• :active_endpoint_cache (Boolean) — default: false —

  When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

• :adaptive_retry_wait_to_fill (Boolean) — default: true —

  Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

• :client_side_monitoring (Boolean) — default: false —

  When ‘true`, client-side metrics will be collected for all API requests from this client.

• :client_side_monitoring_client_id (String) — default: "" —

  Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

• :client_side_monitoring_host (String) — default: "127.0.0.1" —

  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_port (Integer) — default: 31000 —

  Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

  Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

• :convert_params (Boolean) — default: true —

  When ‘true`, an attempt is made to coerce request parameters into the required types.

• :correct_clock_skew (Boolean) — default: true —

  Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

• :defaults_mode (String) — default: "legacy" —

  See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

• :disable_host_prefix_injection (Boolean) — default: false —

  Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

• :disable_request_compression (Boolean) — default: false —

  When set to ‘true’ the request body will not be compressed for supported operations.

• :endpoint (String, URI::HTTPS, URI::HTTP) —

  Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

  'http://example.com'
  'https://example.com'
  'http://example.com:123'
  

• :endpoint_cache_max_entries (Integer) — default: 1000 —

  Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

• :endpoint_cache_max_threads (Integer) — default: 10 —

  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

• :endpoint_cache_poll_interval (Integer) — default: 60 —

  When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

• :endpoint_discovery (Boolean) — default: false —

  When set to ‘true`, endpoint discovery will be enabled for operations when available.

• :ignore_configured_endpoint_urls (Boolean) —

  Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

• :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

  The log formatter.

• :log_level (Symbol) — default: :info —

  The log level to send messages to the ‘:logger` at.

• :logger (Logger) —

  The Logger instance to send log messages to. If this option is not set, logging will be disabled.

• :max_attempts (Integer) — default: 3 —

  An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

• :profile (String) — default: "default" —

  Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

• :request_min_compression_size_bytes (Integer) — default: 10240 —

  The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

• :retry_backoff (Proc) —

  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

• :retry_jitter (Symbol) — default: :none —

  A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

  @see www.awsarchitectureblog.com/2015/03/backoff.html

• :retry_limit (Integer) — default: 3 —

  The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

• :retry_max_delay (Integer) — default: 0 —

  The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

• :retry_mode (String) — default: "legacy" —

  Specifies which retry algorithm to use. Values are:

  • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

  • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

  • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

• :sdk_ua_app_id (String) —

  A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

• :secret_access_key (String)
• :session_token (String)
• :sigv4a_signing_region_set (Array) —

  A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • ‘Aws.config`

  • ‘ENV`

  • ‘~/.aws/config`

• :stub_responses (Boolean) — default: false —

  Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

  ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

• :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

  Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

  • OpenTelemetry (OTel) - To use the OTel provider, install and require the

  ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

• :token_provider (Aws::TokenProvider) —

  A Bearer Token Provider. This can be an instance of any one of the following classes:

  • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

  • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

  When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

• :use_dualstack_endpoint (Boolean) —

  When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

• :use_fips_endpoint (Boolean) —

  When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

• :validate_params (Boolean) — default: true —

  When ‘true`, request parameters are validated before sending the request.

• :endpoint_provider (Aws::AppTest::EndpointProvider) —

  The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::AppTest::EndpointParameters`.

• :http_continue_timeout (Float) — default: 1 —

  The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

• :http_idle_timeout (Float) — default: 5 —

  The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

• :http_open_timeout (Float) — default: 15 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_proxy (URI::HTTP, String) —

  A proxy to send requests through. Formatted like ‘proxy.com:123’.

• :http_read_timeout (Float) — default: 60 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_wire_trace (Boolean) — default: false —

  When ‘true`, HTTP debug output will be sent to the `:logger`.

• :on_chunk_received (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

• :on_chunk_sent (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

• :raise_response_errors (Boolean) — default: true —

  When ‘true`, response errors are raised.

• :ssl_ca_bundle (String) —

  Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

• :ssl_ca_directory (String) —

  Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

• :ssl_ca_store (String) —

  Sets the X509::Store to verify peer certificate.

• :ssl_cert (OpenSSL::X509::Certificate) —

  Sets a client certificate when creating http connections.

• :ssl_key (OpenSSL::PKey) —

  Sets a client key when creating http connections.

• :ssl_timeout (Float) —

  Sets the SSL timeout in seconds

• :ssl_verify_peer (Boolean) — default: true —

  When ‘true`, SSL peer certificates are verified when establishing a connection.

# File 'lib/aws-sdk-apptest/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-apptest/client.rb', line 2299

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-apptest/client.rb', line 2302

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• params ({}) (defaults to: {})

# File 'lib/aws-sdk-apptest/client.rb', line 2272

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::AppTest')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-apptest'
  context[:gem_version] = '1.10.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_test_case(params = {}) ⇒ Types::CreateTestCaseResponse

Creates a test case.

Examples:

Request syntax with placeholder values

resp = client.create_test_case({
  name: "ResourceName", # required
  description: "ResourceDescription",
  steps: [ # required
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
  client_token: "IdempotencyTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure

resp.test_case_id #=> String
resp.test_case_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the test case.

• :description (String) —

  The description of the test case.

• :steps (required, Array<Types::Step>) —

  The steps in the test case.

• :client_token (String) —

  The client token of the test case.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  The specified tags of the test case.

Returns:

• (Types::CreateTestCaseResponse) —

  Returns a response object which responds to the following methods:

  • #test_case_id => String

  • #test_case_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 577

def create_test_case(params = {}, options = {})
  req = build_request(:create_test_case, params)
  req.send_request(options)
end

#create_test_configuration(params = {}) ⇒ Types::CreateTestConfigurationResponse

Creates a test configuration.

Examples:

Request syntax with placeholder values

resp = client.create_test_configuration({
  name: "ResourceName", # required
  description: "ResourceDescription",
  resources: [ # required
    {
      name: "ResourceName", # required
      type: { # required
        cloud_formation: {
          template_location: "S3Uri", # required
          parameters: {
            "String" => "String",
          },
        },
        m2_managed_application: {
          application_id: "Variable", # required
          runtime: "MicroFocus", # required, accepts MicroFocus
          vpc_endpoint_service_name: "Variable",
          listener_port: "Variable",
        },
        m2_non_managed_application: {
          vpc_endpoint_service_name: "Variable", # required
          listener_port: "Variable", # required
          runtime: "BluAge", # required, accepts BluAge
          web_app_name: "Variable",
        },
      },
    },
  ],
  properties: {
    "String" => "String",
  },
  client_token: "IdempotencyTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
  service_settings: {
    kms_key_id: "String",
  },
})

Response structure

resp.test_configuration_id #=> String
resp.test_configuration_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the test configuration.

• :description (String) —

  The description of the test configuration.

• :resources (required, Array<Types::Resource>) —

  The defined resources of the test configuration.

• :properties (Hash<String,String>) —

  The properties of the test configuration.

• :client_token (String) —

  The client token of the test configuration.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  The tags of the test configuration.

• :service_settings (Types::ServiceSettings) —

  The service settings of the test configuration.

Returns:

• (Types::CreateTestConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #test_configuration_id => String

  • #test_configuration_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 664

def create_test_configuration(params = {}, options = {})
  req = build_request(:create_test_configuration, params)
  req.send_request(options)
end

#create_test_suite(params = {}) ⇒ Types::CreateTestSuiteResponse

Creates a test suite.

Examples:

Request syntax with placeholder values

resp = client.create_test_suite({
  name: "ResourceName", # required
  description: "ResourceDescription",
  before_steps: [
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
  after_steps: [
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
  test_cases: { # required
    sequential: ["Identifier"],
  },
  client_token: "IdempotencyTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure

resp.test_suite_id #=> String
resp.test_suite_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the test suite.

• :description (String) —

  The description of the test suite.

• :before_steps (Array<Types::Step>) —

  The before steps of the test suite.

• :after_steps (Array<Types::Step>) —

  The after steps of the test suite.

• :test_cases (required, Types::TestCases) —

  The test cases in the test suite.

• :client_token (String) —

  The client token of the test suite.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  The tags of the test suite.

Returns:

• (Types::CreateTestSuiteResponse) —

  Returns a response object which responds to the following methods:

  • #test_suite_id => String

  • #test_suite_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 887

def create_test_suite(params = {}, options = {})
  req = build_request(:create_test_suite, params)
  req.send_request(options)
end

#delete_test_case(params = {}) ⇒ Struct

Deletes a test case.

Examples:

Request syntax with placeholder values

resp = client.delete_test_case({
  test_case_id: "Identifier", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_case_id (required, String) —

  The test case ID of the test case.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 909

def delete_test_case(params = {}, options = {})
  req = build_request(:delete_test_case, params)
  req.send_request(options)
end

#delete_test_configuration(params = {}) ⇒ Struct

Deletes a test configuration.

Examples:

Request syntax with placeholder values

resp = client.delete_test_configuration({
  test_configuration_id: "Identifier", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_configuration_id (required, String) —

  The test ID of the test configuration.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 931

def delete_test_configuration(params = {}, options = {})
  req = build_request(:delete_test_configuration, params)
  req.send_request(options)
end

#delete_test_run(params = {}) ⇒ Struct

Deletes a test run.

Examples:

Request syntax with placeholder values

resp = client.delete_test_run({
  test_run_id: "Identifier", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_run_id (required, String) —

  The run ID of the test run.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 953

def delete_test_run(params = {}, options = {})
  req = build_request(:delete_test_run, params)
  req.send_request(options)
end

#delete_test_suite(params = {}) ⇒ Struct

Deletes a test suite.

Examples:

Request syntax with placeholder values

resp = client.delete_test_suite({
  test_suite_id: "Identifier", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_id (required, String) —

  The test ID of the test suite.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 975

def delete_test_suite(params = {}, options = {})
  req = build_request(:delete_test_suite, params)
  req.send_request(options)
end

#get_test_case(params = {}) ⇒ Types::GetTestCaseResponse

Gets a test case.

Examples:

Request syntax with placeholder values

resp = client.get_test_case({
  test_case_id: "Identifier", # required
  test_case_version: 1,
})

Response structure

resp.test_case_id #=> String
resp.test_case_arn #=> String
resp.name #=> String
resp.description #=> String
resp.latest_version.version #=> Integer
resp.latest_version.status #=> String, one of "Active", "Deleting"
resp.latest_version.status_reason #=> String
resp.test_case_version #=> Integer
resp.status #=> String, one of "Active", "Deleting"
resp.status_reason #=> String
resp.creation_time #=> Time
resp.last_update_time #=> Time
resp.steps #=> Array
resp.steps[0].name #=> String
resp.steps[0].description #=> String
resp.steps[0].action.resource_action.m2_managed_application_action.resource #=> String
resp.steps[0].action.resource_action.m2_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.steps[0].action.resource_action.m2_managed_application_action.properties.force_stop #=> Boolean
resp.steps[0].action.resource_action.m2_managed_application_action.properties.import_data_set_location #=> String
resp.steps[0].action.resource_action.m2_non_managed_application_action.resource #=> String
resp.steps[0].action.resource_action.m2_non_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.steps[0].action.resource_action.cloud_formation_action.resource #=> String
resp.steps[0].action.resource_action.cloud_formation_action.action_type #=> String, one of "Create", "Delete"
resp.steps[0].action.mainframe_action.resource #=> String
resp.steps[0].action.mainframe_action.action_type.batch.batch_job_name #=> String
resp.steps[0].action.mainframe_action.action_type.batch.batch_job_parameters #=> Hash
resp.steps[0].action.mainframe_action.action_type.batch.batch_job_parameters["String"] #=> String
resp.steps[0].action.mainframe_action.action_type.batch.export_data_set_names #=> Array
resp.steps[0].action.mainframe_action.action_type.batch.export_data_set_names[0] #=> String
resp.steps[0].action.mainframe_action.action_type.tn3270.script.script_location #=> String
resp.steps[0].action.mainframe_action.action_type.tn3270.script.type #=> String, one of "Selenium"
resp.steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names #=> Array
resp.steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names[0] #=> String
resp.steps[0].action.mainframe_action.properties.dms_task_arn #=> String
resp.steps[0].action.compare_action.input.file.source_location #=> String
resp.steps[0].action.compare_action.input.file.target_location #=> String
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets #=> Array
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets[0].type #=> String, one of "PS"
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets[0].name #=> String
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets[0].ccsid #=> String
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.steps[0].action.compare_action.input.file.file_metadata.data_sets[0].length #=> Integer
resp.steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.type #=> String, one of "z/OS-DB2"
resp.steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.type #=> String, one of "PostgreSQL"
resp.steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.steps[0].action.compare_action.output.file.file_location #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_case_id (required, String) —

  The request test ID of the test case.

• :test_case_version (Integer) —

  The test case version of the test case.

Returns:

• (Types::GetTestCaseResponse) —

  Returns a response object which responds to the following methods:

  • #test_case_id => String

  • #test_case_arn => String

  • #name => String

  • #description => String

  • #latest_version => Types::TestCaseLatestVersion

  • #test_case_version => Integer

  • #status => String

  • #status_reason => String

  • #creation_time => Time

  • #last_update_time => Time

  • #steps => Array&lt;Types::Step&gt;

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1066

def get_test_case(params = {}, options = {})
  req = build_request(:get_test_case, params)
  req.send_request(options)
end

#get_test_configuration(params = {}) ⇒ Types::GetTestConfigurationResponse

Gets a test configuration.

Examples:

Request syntax with placeholder values

resp = client.get_test_configuration({
  test_configuration_id: "Identifier", # required
  test_configuration_version: 1,
})

Response structure

resp.test_configuration_id #=> String
resp.name #=> String
resp.test_configuration_arn #=> String
resp.latest_version.version #=> Integer
resp.latest_version.status #=> String, one of "Active", "Deleting"
resp.latest_version.status_reason #=> String
resp.test_configuration_version #=> Integer
resp.status #=> String, one of "Active", "Deleting"
resp.status_reason #=> String
resp.creation_time #=> Time
resp.last_update_time #=> Time
resp.description #=> String
resp.resources #=> Array
resp.resources[0].name #=> String
resp.resources[0].type.cloud_formation.template_location #=> String
resp.resources[0].type.cloud_formation.parameters #=> Hash
resp.resources[0].type.cloud_formation.parameters["String"] #=> String
resp.resources[0].type.m2_managed_application.application_id #=> String
resp.resources[0].type.m2_managed_application.runtime #=> String, one of "MicroFocus"
resp.resources[0].type.m2_managed_application.vpc_endpoint_service_name #=> String
resp.resources[0].type.m2_managed_application.listener_port #=> String
resp.resources[0].type.m2_non_managed_application.vpc_endpoint_service_name #=> String
resp.resources[0].type.m2_non_managed_application.listener_port #=> String
resp.resources[0].type.m2_non_managed_application.runtime #=> String, one of "BluAge"
resp.resources[0].type.m2_non_managed_application.web_app_name #=> String
resp.properties #=> Hash
resp.properties["String"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.service_settings.kms_key_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_configuration_id (required, String) —

  The request test configuration ID.

• :test_configuration_version (Integer) —

  The test configuration version.

Returns:

• (Types::GetTestConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #test_configuration_id => String

  • #name => String

  • #test_configuration_arn => String

  • #latest_version => Types::TestConfigurationLatestVersion

  • #test_configuration_version => Integer

  • #status => String

  • #status_reason => String

  • #creation_time => Time

  • #last_update_time => Time

  • #description => String

  • #resources => Array&lt;Types::Resource&gt;

  • #properties => Hash&lt;String,String&gt;

  • #tags => Hash&lt;String,String&gt;

  • #service_settings => Types::ServiceSettings

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1140

def get_test_configuration(params = {}, options = {})
  req = build_request(:get_test_configuration, params)
  req.send_request(options)
end

#get_test_run_step(params = {}) ⇒ Types::GetTestRunStepResponse

Gets a test run step.

Examples:

Request syntax with placeholder values

resp = client.get_test_run_step({
  test_run_id: "Identifier", # required
  step_name: "ResourceName", # required
  test_case_id: "Identifier",
  test_suite_id: "Identifier",
})

Response structure

resp.step_name #=> String
resp.test_run_id #=> String
resp.test_case_id #=> String
resp.test_case_version #=> Integer
resp.test_suite_id #=> String
resp.test_suite_version #=> Integer
resp.before_step #=> Boolean
resp.after_step #=> Boolean
resp.status #=> String, one of "Success", "Failed", "Running"
resp.status_reason #=> String
resp.run_start_time #=> Time
resp.run_end_time #=> Time
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_managed_application.application_id #=> String
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_managed_application.runtime #=> String, one of "MicroFocus"
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_managed_application.listener_port #=> Integer
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_non_managed_application.vpc_endpoint_service_name #=> String
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_non_managed_application.listener_port #=> Integer
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_non_managed_application.runtime #=> String, one of "BluAge"
resp.step_run_summary.mainframe_action.batch.step_input.resource.m2_non_managed_application.web_app_name #=> String
resp.step_run_summary.mainframe_action.batch.step_input.batch_job_name #=> String
resp.step_run_summary.mainframe_action.batch.step_input.batch_job_parameters #=> Hash
resp.step_run_summary.mainframe_action.batch.step_input.batch_job_parameters["String"] #=> String
resp.step_run_summary.mainframe_action.batch.step_input.export_data_set_names #=> Array
resp.step_run_summary.mainframe_action.batch.step_input.export_data_set_names[0] #=> String
resp.step_run_summary.mainframe_action.batch.step_input.properties.dms_task_arn #=> String
resp.step_run_summary.mainframe_action.batch.step_output.data_set_export_location #=> String
resp.step_run_summary.mainframe_action.batch.step_output.dms_output_location #=> String
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details #=> Array
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details[0].type #=> String, one of "PS"
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details[0].name #=> String
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details[0].ccsid #=> String
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.step_run_summary.mainframe_action.batch.step_output.data_set_details[0].length #=> Integer
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_managed_application.application_id #=> String
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_managed_application.runtime #=> String, one of "MicroFocus"
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_managed_application.listener_port #=> Integer
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_non_managed_application.vpc_endpoint_service_name #=> String
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_non_managed_application.listener_port #=> Integer
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_non_managed_application.runtime #=> String, one of "BluAge"
resp.step_run_summary.mainframe_action.tn3270.step_input.resource.m2_non_managed_application.web_app_name #=> String
resp.step_run_summary.mainframe_action.tn3270.step_input.script.script_location #=> String
resp.step_run_summary.mainframe_action.tn3270.step_input.script.type #=> String, one of "Selenium"
resp.step_run_summary.mainframe_action.tn3270.step_input.export_data_set_names #=> Array
resp.step_run_summary.mainframe_action.tn3270.step_input.export_data_set_names[0] #=> String
resp.step_run_summary.mainframe_action.tn3270.step_input.properties.dms_task_arn #=> String
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_export_location #=> String
resp.step_run_summary.mainframe_action.tn3270.step_output.dms_output_location #=> String
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details #=> Array
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details[0].type #=> String, one of "PS"
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details[0].name #=> String
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details[0].ccsid #=> String
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.step_run_summary.mainframe_action.tn3270.step_output.data_set_details[0].length #=> Integer
resp.step_run_summary.mainframe_action.tn3270.step_output.script_output_location #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_location #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_location #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets #=> Array
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets[0].type #=> String, one of "PS"
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets[0].name #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets[0].ccsid #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.source_data_sets[0].length #=> Integer
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets #=> Array
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets[0].type #=> String, one of "PS"
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets[0].name #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets[0].ccsid #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.step_run_summary.compare_action.type.file_type.datasets.step_input.target_data_sets[0].length #=> Integer
resp.step_run_summary.compare_action.type.file_type.datasets.step_output.comparison_output_location #=> String
resp.step_run_summary.compare_action.type.file_type.datasets.step_output.comparison_status #=> String, one of "Different", "Equivalent", "Equal"
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.source_location #=> String
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.target_location #=> String
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.output_location #=> String
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.source_metadata.type #=> String, one of "z/OS-DB2"
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.source_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.target_metadata.type #=> String, one of "PostgreSQL"
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_input.target_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_output.comparison_output_location #=> String
resp.step_run_summary.compare_action.type.file_type.database_cdc.step_output.comparison_status #=> String, one of "Different", "Equivalent", "Equal"
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_input.template_location #=> String
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_input.parameters #=> Hash
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_input.parameters["String"] #=> String
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_output.stack_id #=> String
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_output.exports #=> Hash
resp.step_run_summary.resource_action.cloud_formation.create_cloudformation.step_output.exports["String"] #=> String
resp.step_run_summary.resource_action.cloud_formation.delete_cloudformation.step_input.stack_id #=> String
resp.step_run_summary.resource_action.m2_managed_application.step_input.application_id #=> String
resp.step_run_summary.resource_action.m2_managed_application.step_input.runtime #=> String
resp.step_run_summary.resource_action.m2_managed_application.step_input.vpc_endpoint_service_name #=> String
resp.step_run_summary.resource_action.m2_managed_application.step_input.listener_port #=> Integer
resp.step_run_summary.resource_action.m2_managed_application.step_input.action_type #=> String, one of "Configure", "Deconfigure"
resp.step_run_summary.resource_action.m2_managed_application.step_input.properties.force_stop #=> Boolean
resp.step_run_summary.resource_action.m2_managed_application.step_input.properties.import_data_set_location #=> String
resp.step_run_summary.resource_action.m2_managed_application.step_output.import_data_set_summary #=> Hash
resp.step_run_summary.resource_action.m2_managed_application.step_output.import_data_set_summary["String"] #=> String
resp.step_run_summary.resource_action.m2_non_managed_application.step_input.vpc_endpoint_service_name #=> String
resp.step_run_summary.resource_action.m2_non_managed_application.step_input.listener_port #=> Integer
resp.step_run_summary.resource_action.m2_non_managed_application.step_input.runtime #=> String, one of "BluAge"
resp.step_run_summary.resource_action.m2_non_managed_application.step_input.web_app_name #=> String
resp.step_run_summary.resource_action.m2_non_managed_application.step_input.action_type #=> String, one of "Configure", "Deconfigure"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_run_id (required, String) —

  The test run ID of the test run step.

• :step_name (required, String) —

  The step name of the test run step.

• :test_case_id (String) —

  The test case ID of a test run step.

• :test_suite_id (String) —

  The test suite ID of a test run step.

Returns:

• (Types::GetTestRunStepResponse) —

  Returns a response object which responds to the following methods:

  • #step_name => String

  • #test_run_id => String

  • #test_case_id => String

  • #test_case_version => Integer

  • #test_suite_id => String

  • #test_suite_version => Integer

  • #before_step => Boolean

  • #after_step => Boolean

  • #status => String

  • #status_reason => String

  • #run_start_time => Time

  • #run_end_time => Time

  • #step_run_summary => Types::StepRunSummary

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1291

def get_test_run_step(params = {}, options = {})
  req = build_request(:get_test_run_step, params)
  req.send_request(options)
end

#get_test_suite(params = {}) ⇒ Types::GetTestSuiteResponse

Gets a test suite.

Examples:

Request syntax with placeholder values

resp = client.get_test_suite({
  test_suite_id: "Identifier", # required
  test_suite_version: 1,
})

Response structure

resp.test_suite_id #=> String
resp.name #=> String
resp.latest_version.version #=> Integer
resp.latest_version.status #=> String, one of "Creating", "Updating", "Active", "Failed", "Deleting"
resp.latest_version.status_reason #=> String
resp.test_suite_version #=> Integer
resp.status #=> String, one of "Creating", "Updating", "Active", "Failed", "Deleting"
resp.status_reason #=> String
resp.test_suite_arn #=> String
resp.creation_time #=> Time
resp.last_update_time #=> Time
resp.description #=> String
resp.before_steps #=> Array
resp.before_steps[0].name #=> String
resp.before_steps[0].description #=> String
resp.before_steps[0].action.resource_action.m2_managed_application_action.resource #=> String
resp.before_steps[0].action.resource_action.m2_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.before_steps[0].action.resource_action.m2_managed_application_action.properties.force_stop #=> Boolean
resp.before_steps[0].action.resource_action.m2_managed_application_action.properties.import_data_set_location #=> String
resp.before_steps[0].action.resource_action.m2_non_managed_application_action.resource #=> String
resp.before_steps[0].action.resource_action.m2_non_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.before_steps[0].action.resource_action.cloud_formation_action.resource #=> String
resp.before_steps[0].action.resource_action.cloud_formation_action.action_type #=> String, one of "Create", "Delete"
resp.before_steps[0].action.mainframe_action.resource #=> String
resp.before_steps[0].action.mainframe_action.action_type.batch.batch_job_name #=> String
resp.before_steps[0].action.mainframe_action.action_type.batch.batch_job_parameters #=> Hash
resp.before_steps[0].action.mainframe_action.action_type.batch.batch_job_parameters["String"] #=> String
resp.before_steps[0].action.mainframe_action.action_type.batch.export_data_set_names #=> Array
resp.before_steps[0].action.mainframe_action.action_type.batch.export_data_set_names[0] #=> String
resp.before_steps[0].action.mainframe_action.action_type.tn3270.script.script_location #=> String
resp.before_steps[0].action.mainframe_action.action_type.tn3270.script.type #=> String, one of "Selenium"
resp.before_steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names #=> Array
resp.before_steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names[0] #=> String
resp.before_steps[0].action.mainframe_action.properties.dms_task_arn #=> String
resp.before_steps[0].action.compare_action.input.file.source_location #=> String
resp.before_steps[0].action.compare_action.input.file.target_location #=> String
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets #=> Array
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].type #=> String, one of "PS"
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].name #=> String
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].ccsid #=> String
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.before_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].length #=> Integer
resp.before_steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.type #=> String, one of "z/OS-DB2"
resp.before_steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.before_steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.type #=> String, one of "PostgreSQL"
resp.before_steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.before_steps[0].action.compare_action.output.file.file_location #=> String
resp.after_steps #=> Array
resp.after_steps[0].name #=> String
resp.after_steps[0].description #=> String
resp.after_steps[0].action.resource_action.m2_managed_application_action.resource #=> String
resp.after_steps[0].action.resource_action.m2_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.after_steps[0].action.resource_action.m2_managed_application_action.properties.force_stop #=> Boolean
resp.after_steps[0].action.resource_action.m2_managed_application_action.properties.import_data_set_location #=> String
resp.after_steps[0].action.resource_action.m2_non_managed_application_action.resource #=> String
resp.after_steps[0].action.resource_action.m2_non_managed_application_action.action_type #=> String, one of "Configure", "Deconfigure"
resp.after_steps[0].action.resource_action.cloud_formation_action.resource #=> String
resp.after_steps[0].action.resource_action.cloud_formation_action.action_type #=> String, one of "Create", "Delete"
resp.after_steps[0].action.mainframe_action.resource #=> String
resp.after_steps[0].action.mainframe_action.action_type.batch.batch_job_name #=> String
resp.after_steps[0].action.mainframe_action.action_type.batch.batch_job_parameters #=> Hash
resp.after_steps[0].action.mainframe_action.action_type.batch.batch_job_parameters["String"] #=> String
resp.after_steps[0].action.mainframe_action.action_type.batch.export_data_set_names #=> Array
resp.after_steps[0].action.mainframe_action.action_type.batch.export_data_set_names[0] #=> String
resp.after_steps[0].action.mainframe_action.action_type.tn3270.script.script_location #=> String
resp.after_steps[0].action.mainframe_action.action_type.tn3270.script.type #=> String, one of "Selenium"
resp.after_steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names #=> Array
resp.after_steps[0].action.mainframe_action.action_type.tn3270.export_data_set_names[0] #=> String
resp.after_steps[0].action.mainframe_action.properties.dms_task_arn #=> String
resp.after_steps[0].action.compare_action.input.file.source_location #=> String
resp.after_steps[0].action.compare_action.input.file.target_location #=> String
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets #=> Array
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].type #=> String, one of "PS"
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].name #=> String
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].ccsid #=> String
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].format #=> String, one of "FIXED", "VARIABLE", "LINE_SEQUENTIAL"
resp.after_steps[0].action.compare_action.input.file.file_metadata.data_sets[0].length #=> Integer
resp.after_steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.type #=> String, one of "z/OS-DB2"
resp.after_steps[0].action.compare_action.input.file.file_metadata.database_cdc.source_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.after_steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.type #=> String, one of "PostgreSQL"
resp.after_steps[0].action.compare_action.input.file.file_metadata.database_cdc.target_metadata.capture_tool #=> String, one of "Precisely", "AWS DMS"
resp.after_steps[0].action.compare_action.output.file.file_location #=> String
resp.test_cases.sequential #=> Array
resp.test_cases.sequential[0] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_id (required, String) —

  The ID of the test suite.

• :test_suite_version (Integer) —

  The version of the test suite.

Returns:

• (Types::GetTestSuiteResponse) —

  Returns a response object which responds to the following methods:

  • #test_suite_id => String

  • #name => String

  • #latest_version => Types::TestSuiteLatestVersion

  • #test_suite_version => Integer

  • #status => String

  • #status_reason => String

  • #test_suite_arn => String

  • #creation_time => Time

  • #last_update_time => Time

  • #description => String

  • #before_steps => Array&lt;Types::Step&gt;

  • #after_steps => Array&lt;Types::Step&gt;

  • #test_cases => Types::TestCases

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1421

def get_test_suite(params = {}, options = {})
  req = build_request(:get_test_suite, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists tags for a resource.

Examples:

Request syntax with placeholder values

resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure

resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the resource.

Returns:

• (Types::ListTagsForResourceResponse) —

  Returns a response object which responds to the following methods:

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1450

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_test_cases(params = {}) ⇒ Types::ListTestCasesResponse

Lists test cases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_cases({
  test_case_ids: ["Identifier"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_cases #=> Array
resp.test_cases[0].test_case_id #=> String
resp.test_cases[0].test_case_arn #=> String
resp.test_cases[0].name #=> String
resp.test_cases[0].status_reason #=> String
resp.test_cases[0].latest_version #=> Integer
resp.test_cases[0].status #=> String, one of "Active", "Deleting"
resp.test_cases[0].creation_time #=> Time
resp.test_cases[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_case_ids (Array<String>) —

  The IDs of the test cases.

• :next_token (String) —

  The next token of the test cases.

• :max_results (Integer) —

  The maximum results of the test case.

Returns:

• (Types::ListTestCasesResponse) —

  Returns a response object which responds to the following methods:

  • #test_cases => Array&lt;Types::TestCaseSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1498

def list_test_cases(params = {}, options = {})
  req = build_request(:list_test_cases, params)
  req.send_request(options)
end

#list_test_configurations(params = {}) ⇒ Types::ListTestConfigurationsResponse

Lists test configurations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_configurations({
  test_configuration_ids: ["Identifier"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_configurations #=> Array
resp.test_configurations[0].test_configuration_id #=> String
resp.test_configurations[0].name #=> String
resp.test_configurations[0].status_reason #=> String
resp.test_configurations[0].latest_version #=> Integer
resp.test_configurations[0].test_configuration_arn #=> String
resp.test_configurations[0].status #=> String, one of "Active", "Deleting"
resp.test_configurations[0].creation_time #=> Time
resp.test_configurations[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_configuration_ids (Array<String>) —

  The configuration IDs of the test configurations.

• :next_token (String) —

  The next token for the test configurations.

• :max_results (Integer) —

  The maximum results of the test configuration.

Returns:

• (Types::ListTestConfigurationsResponse) —

  Returns a response object which responds to the following methods:

  • #test_configurations => Array&lt;Types::TestConfigurationSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1546

def list_test_configurations(params = {}, options = {})
  req = build_request(:list_test_configurations, params)
  req.send_request(options)
end

#list_test_run_steps(params = {}) ⇒ Types::ListTestRunStepsResponse

Lists test run steps.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_run_steps({
  test_run_id: "Identifier", # required
  test_case_id: "Identifier",
  test_suite_id: "Identifier",
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_run_steps #=> Array
resp.test_run_steps[0].step_name #=> String
resp.test_run_steps[0].test_run_id #=> String
resp.test_run_steps[0].test_case_id #=> String
resp.test_run_steps[0].test_case_version #=> Integer
resp.test_run_steps[0].test_suite_id #=> String
resp.test_run_steps[0].test_suite_version #=> Integer
resp.test_run_steps[0].before_step #=> Boolean
resp.test_run_steps[0].after_step #=> Boolean
resp.test_run_steps[0].status #=> String, one of "Success", "Failed", "Running"
resp.test_run_steps[0].status_reason #=> String
resp.test_run_steps[0].run_start_time #=> Time
resp.test_run_steps[0].run_end_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_run_id (required, String) —

  The test run ID of the test run steps.

• :test_case_id (String) —

  The test case ID of the test run steps.

• :test_suite_id (String) —

  The test suite ID of the test run steps.

• :next_token (String) —

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

• :max_results (Integer) —

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

Returns:

• (Types::ListTestRunStepsResponse) —

  Returns a response object which responds to the following methods:

  • #test_run_steps => Array&lt;Types::TestRunStepSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1606

def list_test_run_steps(params = {}, options = {})
  req = build_request(:list_test_run_steps, params)
  req.send_request(options)
end

#list_test_run_test_cases(params = {}) ⇒ Types::ListTestRunTestCasesResponse

Lists test run test cases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_run_test_cases({
  test_run_id: "Identifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_run_test_cases #=> Array
resp.test_run_test_cases[0].test_case_id #=> String
resp.test_run_test_cases[0].test_case_version #=> Integer
resp.test_run_test_cases[0].test_run_id #=> String
resp.test_run_test_cases[0].status #=> String, one of "Success", "Running", "Failed"
resp.test_run_test_cases[0].status_reason #=> String
resp.test_run_test_cases[0].run_start_time #=> Time
resp.test_run_test_cases[0].run_end_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_run_id (required, String) —

  The test run ID of the test cases.

• :next_token (String) —

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

• :max_results (Integer) —

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

Returns:

• (Types::ListTestRunTestCasesResponse) —

  Returns a response object which responds to the following methods:

  • #test_run_test_cases => Array&lt;Types::TestCaseRunSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1655

def list_test_run_test_cases(params = {}, options = {})
  req = build_request(:list_test_run_test_cases, params)
  req.send_request(options)
end

#list_test_runs(params = {}) ⇒ Types::ListTestRunsResponse

Lists test runs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_runs({
  test_suite_id: "Identifier",
  test_run_ids: ["Identifier"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_runs #=> Array
resp.test_runs[0].test_run_id #=> String
resp.test_runs[0].test_run_arn #=> String
resp.test_runs[0].test_suite_id #=> String
resp.test_runs[0].test_suite_version #=> Integer
resp.test_runs[0].test_configuration_id #=> String
resp.test_runs[0].test_configuration_version #=> Integer
resp.test_runs[0].status #=> String, one of "Success", "Running", "Failed", "Deleting"
resp.test_runs[0].status_reason #=> String
resp.test_runs[0].run_start_time #=> Time
resp.test_runs[0].run_end_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_id (String) —

  The test suite ID of the test runs.

• :test_run_ids (Array<String>) —

  The test run IDs of the test runs.

• :next_token (String) —

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

• :max_results (Integer) —

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

Returns:

• (Types::ListTestRunsResponse) —

  Returns a response object which responds to the following methods:

  • #test_runs => Array&lt;Types::TestRunSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1710

def list_test_runs(params = {}, options = {})
  req = build_request(:list_test_runs, params)
  req.send_request(options)
end

#list_test_suites(params = {}) ⇒ Types::ListTestSuitesResponse

Lists test suites.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_test_suites({
  test_suite_ids: ["Identifier"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure

resp.test_suites #=> Array
resp.test_suites[0].test_suite_id #=> String
resp.test_suites[0].name #=> String
resp.test_suites[0].status_reason #=> String
resp.test_suites[0].latest_version #=> Integer
resp.test_suites[0].test_suite_arn #=> String
resp.test_suites[0].status #=> String, one of "Creating", "Updating", "Active", "Failed", "Deleting"
resp.test_suites[0].creation_time #=> Time
resp.test_suites[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_ids (Array<String>) —

  The suite ID of the test suites.

• :next_token (String) —

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

• :max_results (Integer) —

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

Returns:

• (Types::ListTestSuitesResponse) —

  Returns a response object which responds to the following methods:

  • #test_suites => Array&lt;Types::TestSuiteSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1759

def list_test_suites(params = {}, options = {})
  req = build_request(:list_test_suites, params)
  req.send_request(options)
end

#start_test_run(params = {}) ⇒ Types::StartTestRunResponse

Starts a test run.

Examples:

Request syntax with placeholder values

resp = client.start_test_run({
  test_suite_id: "Identifier", # required
  test_configuration_id: "Identifier",
  client_token: "IdempotencyTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure

resp.test_run_id #=> String
resp.test_run_status #=> String, one of "Success", "Running", "Failed", "Deleting"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_id (required, String) —

  The test suite ID of the test run.

• :test_configuration_id (String) —

  The configuration ID of the test run.

• :client_token (String) —

  The client token of the test run.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  The tags of the test run.

Returns:

• (Types::StartTestRunResponse) —

  Returns a response object which responds to the following methods:

  • #test_run_id => String

  • #test_run_status => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1806

def start_test_run(params = {}, options = {})
  req = build_request(:start_test_run, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Specifies tags of a resource.

Examples:

Request syntax with placeholder values

resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

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

• :tags (required, Hash<String,String>) —

  The tags of the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1834

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Untags a resource.

Examples:

Request syntax with placeholder values

resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the resource.

• :tag_keys (required, Array<String>) —

  The tag keys of the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1860

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_test_case(params = {}) ⇒ Types::UpdateTestCaseResponse

Updates a test case.

Examples:

Request syntax with placeholder values

resp = client.update_test_case({
  test_case_id: "Identifier", # required
  description: "ResourceDescription",
  steps: [
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
})

Response structure

resp.test_case_id #=> String
resp.test_case_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_case_id (required, String) —

  The test case ID of the test case.

• :description (String) —

  The description of the test case.

• :steps (Array<Types::Step>) —

  The steps of the test case.

Returns:

• (Types::UpdateTestCaseResponse) —

  Returns a response object which responds to the following methods:

  • #test_case_id => String

  • #test_case_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 1979

def update_test_case(params = {}, options = {})
  req = build_request(:update_test_case, params)
  req.send_request(options)
end

#update_test_configuration(params = {}) ⇒ Types::UpdateTestConfigurationResponse

Updates a test configuration.

Examples:

Request syntax with placeholder values

resp = client.update_test_configuration({
  test_configuration_id: "Identifier", # required
  description: "ResourceDescription",
  resources: [
    {
      name: "ResourceName", # required
      type: { # required
        cloud_formation: {
          template_location: "S3Uri", # required
          parameters: {
            "String" => "String",
          },
        },
        m2_managed_application: {
          application_id: "Variable", # required
          runtime: "MicroFocus", # required, accepts MicroFocus
          vpc_endpoint_service_name: "Variable",
          listener_port: "Variable",
        },
        m2_non_managed_application: {
          vpc_endpoint_service_name: "Variable", # required
          listener_port: "Variable", # required
          runtime: "BluAge", # required, accepts BluAge
          web_app_name: "Variable",
        },
      },
    },
  ],
  properties: {
    "String" => "String",
  },
  service_settings: {
    kms_key_id: "String",
  },
})

Response structure

resp.test_configuration_id #=> String
resp.test_configuration_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_configuration_id (required, String) —

  The test configuration ID of the test configuration.

• :description (String) —

  The description of the test configuration.

• :resources (Array<Types::Resource>) —

  The resources of the test configuration.

• :properties (Hash<String,String>) —

  The properties of the test configuration.

• :service_settings (Types::ServiceSettings) —

  The service settings of the test configuration.

Returns:

• (Types::UpdateTestConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #test_configuration_id => String

  • #test_configuration_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 2053

def update_test_configuration(params = {}, options = {})
  req = build_request(:update_test_configuration, params)
  req.send_request(options)
end

#update_test_suite(params = {}) ⇒ Types::UpdateTestSuiteResponse

Updates a test suite.

Examples:

Request syntax with placeholder values

resp = client.update_test_suite({
  test_suite_id: "Identifier", # required
  description: "ResourceDescription",
  before_steps: [
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
  after_steps: [
    {
      name: "ResourceName", # required
      description: "ResourceDescription",
      action: { # required
        resource_action: {
          m2_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
            properties: {
              force_stop: false,
              import_data_set_location: "Variable",
            },
          },
          m2_non_managed_application_action: {
            resource: "Variable", # required
            action_type: "Configure", # required, accepts Configure, Deconfigure
          },
          cloud_formation_action: {
            resource: "Variable", # required
            action_type: "Create", # accepts Create, Delete
          },
        },
        mainframe_action: {
          resource: "Variable", # required
          action_type: { # required
            batch: {
              batch_job_name: "Variable", # required
              batch_job_parameters: {
                "String" => "String",
              },
              export_data_set_names: ["String100"],
            },
            tn3270: {
              script: { # required
                script_location: "S3Uri", # required
                type: "Selenium", # required, accepts Selenium
              },
              export_data_set_names: ["String100"],
            },
          },
          properties: {
            dms_task_arn: "Variable",
          },
        },
        compare_action: {
          input: { # required
            file: {
              source_location: "Variable", # required
              target_location: "Variable", # required
              file_metadata: { # required
                data_sets: [
                  {
                    type: "PS", # required, accepts PS
                    name: "String100", # required
                    ccsid: "String50", # required
                    format: "FIXED", # required, accepts FIXED, VARIABLE, LINE_SEQUENTIAL
                    length: 1, # required
                  },
                ],
                database_cdc: {
                  source_metadata: { # required
                    type: "z/OS-DB2", # required, accepts z/OS-DB2
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                  target_metadata: { # required
                    type: "PostgreSQL", # required, accepts PostgreSQL
                    capture_tool: "Precisely", # required, accepts Precisely, AWS DMS
                  },
                },
              },
            },
          },
          output: {
            file: {
              file_location: "S3Uri",
            },
          },
        },
      },
    },
  ],
  test_cases: {
    sequential: ["Identifier"],
  },
})

Response structure

resp.test_suite_id #=> String
resp.test_suite_version #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :test_suite_id (required, String) —

  The test suite ID of the test suite.

• :description (String) —

  The description of the test suite.

• :before_steps (Array<Types::Step>) —

  The before steps for the test suite.

• :after_steps (Array<Types::Step>) —

  The after steps of the test suite.

• :test_cases (Types::TestCases) —

  The test cases in the test suite.

Returns:

• (Types::UpdateTestSuiteResponse) —

  Returns a response object which responds to the following methods:

  • #test_suite_id => String

  • #test_suite_version => Integer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-apptest/client.rb', line 2263

def update_test_suite(params = {}, options = {})
  req = build_request(:update_test_suite, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

# File 'lib/aws-sdk-apptest/client.rb', line 2292

def waiter_names
  []
end