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

CreateApplication

Creates a new application with given parameters. Requires an existing runtime environment and application definition file.

Request Syntax


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

{
   "clientToken": "string",
   "definition": { ... },
   "description": "string",
   "engineType": "string",
   "kmsKeyId": "string",
   "name": "string",
   "roleArn": "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 the service generates to ensure the idempotency of the request to create an application. 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

definition

The application definition for this application. You can specify either inline JSON or an S3 bucket location.

Type: Definition object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

description

The description of the application.

Type: String

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

Required: No

engineType

The type of the target platform for this application.

Type: String

Valid Values: microfocus | bluage

Required: Yes

kmsKeyId

The identifier of a customer managed key.

Type: String

Required: No

name

The unique identifier of the application.

Type: String

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

Required: Yes

roleArn

The Amazon Resource Name (ARN) that identifies a role that the application uses to access AWS resources that are not part of the application or are in a different AWS account.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: No

tags

A list of tags to apply to the application.

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

{
   "applicationArn": "string",
   "applicationId": "string",
   "applicationVersion": number
}

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.

applicationArn

The Amazon Resource Name (ARN) of the application.

Type: String

applicationId

The unique application identifier.

Type: String

Pattern: ^\S{1,80}$

applicationVersion

The version number of the application.

Type: Integer

Valid Range: Minimum value of 1.

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