GetTestConfigurationCommand

Suggest an Edit

Gets a test configuration.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppTestClient, GetTestConfigurationCommand } from "@aws-sdk/client-apptest"; // ES Modules import
// const { AppTestClient, GetTestConfigurationCommand } = require("@aws-sdk/client-apptest"); // CommonJS import
const client = new AppTestClient(config);
const input = { // GetTestConfigurationRequest
  testConfigurationId: "STRING_VALUE", // required
  testConfigurationVersion: Number("int"),
};
const command = new GetTestConfigurationCommand(input);
const response = await client.send(command);
// { // GetTestConfigurationResponse
//   testConfigurationId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   testConfigurationArn: "STRING_VALUE", // required
//   latestVersion: { // TestConfigurationLatestVersion
//     version: Number("int"), // required
//     status: "Active" || "Deleting", // required
//     statusReason: "STRING_VALUE",
//   },
//   testConfigurationVersion: Number("int"), // required
//   status: "Active" || "Deleting", // required
//   statusReason: "STRING_VALUE",
//   creationTime: new Date("TIMESTAMP"), // required
//   lastUpdateTime: new Date("TIMESTAMP"), // required
//   description: "STRING_VALUE",
//   resources: [ // ResourceList // required
//     { // Resource
//       name: "STRING_VALUE", // required
//       type: { // ResourceType Union: only one key present
//         cloudFormation: { // CloudFormation
//           templateLocation: "STRING_VALUE", // required
//           parameters: { // Properties
//             "<keys>": "STRING_VALUE",
//           },
//         },
//         m2ManagedApplication: { // M2ManagedApplication
//           applicationId: "STRING_VALUE", // required
//           runtime: "MicroFocus", // required
//           vpcEndpointServiceName: "STRING_VALUE",
//           listenerPort: "STRING_VALUE",
//         },
//         m2NonManagedApplication: { // M2NonManagedApplication
//           vpcEndpointServiceName: "STRING_VALUE", // required
//           listenerPort: "STRING_VALUE", // required
//           runtime: "BluAge", // required
//           webAppName: "STRING_VALUE",
//         },
//       },
//     },
//   ],
//   properties: { // required
//     "<keys>": "STRING_VALUE",
//   },
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   serviceSettings: { // ServiceSettings
//     kmsKeyId: "STRING_VALUE",
//   },
// };

GetTestConfigurationCommand Input

See GetTestConfigurationCommandInput for more details

Parameter
Type
Description
testConfigurationId
Required
string | undefined

The request test configuration ID.

testConfigurationVersion
number | undefined

The test configuration version.

GetTestConfigurationCommand Output

See GetTestConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationTime
Required
Date | undefined

The creation time of the test configuration.

lastUpdateTime
Required
Date | undefined

The last update time of the test configuration.

latestVersion
Required
TestConfigurationLatestVersion | undefined

The latest version of the test configuration.

name
Required
string | undefined

The test configuration name

properties
Required
Record<string, string> | undefined

The properties of the test configuration.

resources
Required
Resource[] | undefined

The resources of the test configuration.

status
Required
TestConfigurationLifecycle | undefined

The status of the test configuration.

testConfigurationArn
Required
string | undefined

The test configuration Amazon Resource Name (ARN).

testConfigurationId
Required
string | undefined

The response test configuration ID.

testConfigurationVersion
Required
number | undefined

The test configuration version.

description
string | undefined

The description of the test configuration.

serviceSettings
ServiceSettings | undefined

The service settings of the test configuration.

statusReason
string | undefined

The status reason of the test configuration.

tags
Record<string, string> | undefined

The tags of the test configuration.

Throws

Name
Fault
Details
AccessDeniedException
client

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

InternalServerException
server

An unexpected error occurred during the processing of the request.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The number of requests made exceeds the limit.

ValidationException
client

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

AppTestServiceException
Base exception class for all service exceptions from AppTest service.