Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateEnvironment

Creates a runtime environment for a given runtime engine.

Request Syntax


POST /environments HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "engineType": "string",
   "engineVersion": "string",
   "highAvailabilityConfig": { 
      "desiredCapacity": number
   },
   "instanceType": "string",
   "kmsKeyId": "string",
   "name": "string",
   "preferredMaintenanceWindow": "string",
   "publiclyAccessible": boolean,
   "securityGroupIds": [ "string" ],
   "storageConfigurations": [ 
      { ... }
   ],
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Type: String

Required: No

description

The description of the runtime environment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

engineType

The engine type for the runtime environment.

Type: String

Valid Values: microfocus | bluage

Required: Yes

engineVersion

The version of the engine type for the runtime environment.

Type: String

Pattern: ^\S{1,10}$

Required: No

highAvailabilityConfig

The details of a high availability configuration for this runtime environment.

Type: HighAvailabilityConfig object

Required: No

instanceType

The type of instance for the runtime environment.

Type: String

Pattern: ^\S{1,20}$

Required: Yes

kmsKeyId

The identifier of a customer managed key.

Type: String

Required: No

name

The name of the runtime environment. Must be unique within the account.

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Required: Yes

preferredMaintenanceWindow

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Type: String

Pattern: ^\S{1,50}$

Required: No

publiclyAccessible

Specifies whether the runtime environment is publicly accessible.

Type: Boolean

Required: No

securityGroupIds

The list of security groups for the VPC associated with this runtime environment.

Type: Array of strings

Pattern: ^\S{1,50}$

Required: No

storageConfigurations

Optional. The storage configurations for this runtime environment.

Type: Array of StorageConfiguration objects

Required: No

subnetIds

The list of subnets associated with the VPC for this runtime environment.

Type: Array of strings

Pattern: ^\S{1,50}$

Required: No

tags

The tags for the runtime environment.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:).+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "environmentId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environmentId

The unique identifier of the runtime environment.

Type: String

Pattern: ^\S{1,80}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

The parameters provided in the request conflict with existing resources.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ServiceQuotaExceededException

One or more quotas for AWS Mainframe Modernization exceeds the limit.

HTTP Status Code: 402

ThrottlingException

The number of requests made exceeds the limit.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400