AWS API Changes

2022/12/15 - AWSMainframeModernization - 6 updated api methods

Changes Adds an optional create-only `KmsKeyId` property to Environment and Application resources.

CreateApplication (updated)

Link ¶
Changes (request)

{'kmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.create_application(
    clientToken='string',
    definition={
        'content': 'string',
        's3Location': 'string'
    },
    description='string',
    engineType='microfocus'|'bluage',
    kmsKeyId='string',
    name='string',
    tags={
        'string': 'string'
    }
)

type clientToken

string

param 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.

This field is autopopulated if not provided.

type definition

dict

param definition

[REQUIRED]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: content, s3Location.

content (string) --

The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.
s3Location (string) --

The S3 bucket that contains the application definition.

type description

string

param description

The description of the application.

type engineType

string

param engineType

[REQUIRED]

The type of the target platform for this application.

type kmsKeyId

string

param kmsKeyId

The identifier of a customer managed key.

type name

string

param name

[REQUIRED]

The unique identifier of the application.

type tags

dict

param tags

A list of tags to apply to the application.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'applicationId': 'string',
    'applicationVersion': 123
}

Response Structure

(dict) --
- applicationArn (string) --
  
  The Amazon Resource Name (ARN) of the application.
- applicationId (string) --
  
  The unique application identifier.
- applicationVersion (integer) --
  
  The version number of the application.

CreateEnvironment (updated)

Link ¶
Changes (request)

{'kmsKeyId': 'string'}

Creates a runtime environment for a given runtime engine.

See also: AWS API Documentation

Request Syntax

client.create_environment(
    clientToken='string',
    description='string',
    engineType='microfocus'|'bluage',
    engineVersion='string',
    highAvailabilityConfig={
        'desiredCapacity': 123
    },
    instanceType='string',
    kmsKeyId='string',
    name='string',
    preferredMaintenanceWindow='string',
    publiclyAccessible=True|False,
    securityGroupIds=[
        'string',
    ],
    storageConfigurations=[
        {
            'efs': {
                'fileSystemId': 'string',
                'mountPoint': 'string'
            },
            'fsx': {
                'fileSystemId': 'string',
                'mountPoint': 'string'
            }
        },
    ],
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)

type clientToken

string

param 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.

This field is autopopulated if not provided.

type description

string

param description

The description of the runtime environment.

type engineType

string

param engineType

[REQUIRED]

The engine type for the runtime environment.

type engineVersion

string

param engineVersion

The version of the engine type for the runtime environment.

type highAvailabilityConfig

dict

param highAvailabilityConfig

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

desiredCapacity (integer) -- [REQUIRED]

The number of instances in a high availability configuration.

type instanceType

string

param instanceType

[REQUIRED]

The type of instance for the runtime environment.

type kmsKeyId

string

param kmsKeyId

The identifier of a customer managed key.

type name

string

param name

[REQUIRED]

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

type preferredMaintenanceWindow

string

param preferredMaintenanceWindow

Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

type publiclyAccessible

boolean

param publiclyAccessible

Specifies whether the runtime environment is publicly accessible.

type securityGroupIds

list

param securityGroupIds

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

(string) --

type storageConfigurations

list

param storageConfigurations

Optional. The storage configurations for this runtime environment.

(dict) --

Defines the storage configuration for a runtime environment.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: efs, fsx.
- efs (dict) --
  
  Defines the storage configuration for an Amazon EFS file system.
  - fileSystemId (string) -- [REQUIRED]
    
    The file system identifier.
  - mountPoint (string) -- [REQUIRED]
    
    The mount point for the file system.
- fsx (dict) --
  
  Defines the storage configuration for an Amazon FSx file system.
  - fileSystemId (string) -- [REQUIRED]
    
    The file system identifier.
  - mountPoint (string) -- [REQUIRED]
    
    The mount point for the file system.

type subnetIds

list

param subnetIds

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

(string) --

type tags

dict

param tags

The tags for the runtime environment.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

(dict) --
- environmentId (string) --
  
  The unique identifier of the runtime environment.

GetApplication (updated)

Link ¶
Changes (response)

{'kmsKeyId': 'string', 'status': {'Deleting From Environment'}}

Describes the details of a specific application.

See also: AWS API Documentation

Request Syntax

client.get_application(
    applicationId='string'
)

type applicationId

string

param applicationId

[REQUIRED]

The identifier of the application.

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'applicationId': 'string',
    'creationTime': datetime(2015, 1, 1),
    'deployedVersion': {
        'applicationVersion': 123,
        'status': 'Deploying'|'Succeeded'|'Failed',
        'statusReason': 'string'
    },
    'description': 'string',
    'engineType': 'microfocus'|'bluage',
    'environmentId': 'string',
    'kmsKeyId': 'string',
    'lastStartTime': datetime(2015, 1, 1),
    'latestVersion': {
        'applicationVersion': 123,
        'creationTime': datetime(2015, 1, 1),
        'status': 'Creating'|'Available'|'Failed',
        'statusReason': 'string'
    },
    'listenerArns': [
        'string',
    ],
    'listenerPorts': [
        123,
    ],
    'loadBalancerDnsName': 'string',
    'logGroups': [
        {
            'logGroupName': 'string',
            'logType': 'string'
        },
    ],
    'name': 'string',
    'status': 'Creating'|'Created'|'Available'|'Ready'|'Starting'|'Running'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Deleting From Environment',
    'statusReason': 'string',
    'tags': {
        'string': 'string'
    },
    'targetGroupArns': [
        'string',
    ]
}

Response Structure

(dict) --
- applicationArn (string) --
  
  The Amazon Resource Name (ARN) of the application.
- applicationId (string) --
  
  The identifier of the application.
- creationTime (datetime) --
  
  The timestamp when this application was created.
- deployedVersion (dict) --
  
  The version of the application that is deployed.
  - applicationVersion (integer) --
    
    The version of the deployed application.
  - status (string) --
    
    The status of the deployment.
  - statusReason (string) --
    
    The reason for the reported status.
- description (string) --
  
  The description of the application.
- engineType (string) --
  
  The type of the target platform for the application.
- environmentId (string) --
  
  The identifier of the runtime environment where you want to deploy the application.
- kmsKeyId (string) --
  
  The identifier of a customer managed key.
- lastStartTime (datetime) --
  
  The timestamp when you last started the application. Null until the application runs for the first time.
- latestVersion (dict) --
  
  The latest version of the application.
  - applicationVersion (integer) --
    
    The application version.
  - creationTime (datetime) --
    
    The timestamp when the application version was created.
  - status (string) --
    
    The status of the application.
  - statusReason (string) --
    
    The reason for the reported status.
- listenerArns (list) --
  
  The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.
  - (string) --
- listenerPorts (list) --
  
  The port associated with the network load balancer listener created in your Amazon Web Services account.
  - (integer) --
- loadBalancerDnsName (string) --
  
  The public DNS name of the load balancer created in your Amazon Web Services account.
- logGroups (list) --
  
  The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.
  - (dict) --
    
    A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.
    - logGroupName (string) --
      
      The name of the log group.
    - logType (string) --
      
      The type of log.
- name (string) --
  
  The unique identifier of the application.
- status (string) --
  
  The status of the application.
- statusReason (string) --
  
  The reason for the reported status.
- tags (dict) --
  
  A list of tags associated with the application.
  - (string) --
    - (string) --
- targetGroupArns (list) --
  
  Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
  - (string) --

GetEnvironment (updated)

Link ¶
Changes (response)

{'kmsKeyId': 'string', 'status': {'Updating'}}

Describes a specific runtime environment.

See also: AWS API Documentation

Request Syntax

client.get_environment(
    environmentId='string'
)

type environmentId

string

param environmentId

[REQUIRED]

The unique identifier of the runtime environment.

rtype

dict

returns

Response Syntax

{
    'actualCapacity': 123,
    'creationTime': datetime(2015, 1, 1),
    'description': 'string',
    'engineType': 'microfocus'|'bluage',
    'engineVersion': 'string',
    'environmentArn': 'string',
    'environmentId': 'string',
    'highAvailabilityConfig': {
        'desiredCapacity': 123
    },
    'instanceType': 'string',
    'kmsKeyId': 'string',
    'loadBalancerArn': 'string',
    'name': 'string',
    'pendingMaintenance': {
        'engineVersion': 'string',
        'schedule': {
            'endTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1)
        }
    },
    'preferredMaintenanceWindow': 'string',
    'publiclyAccessible': True|False,
    'securityGroupIds': [
        'string',
    ],
    'status': 'Creating'|'Available'|'Deleting'|'Failed'|'Updating',
    'statusReason': 'string',
    'storageConfigurations': [
        {
            'efs': {
                'fileSystemId': 'string',
                'mountPoint': 'string'
            },
            'fsx': {
                'fileSystemId': 'string',
                'mountPoint': 'string'
            }
        },
    ],
    'subnetIds': [
        'string',
    ],
    'tags': {
        'string': 'string'
    },
    'vpcId': 'string'
}

Response Structure

(dict) --
- actualCapacity (integer) --
  
  The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
- creationTime (datetime) --
  
  The timestamp when the runtime environment was created.
- description (string) --
  
  The description of the runtime environment.
- engineType (string) --
  
  The target platform for the runtime environment.
- engineVersion (string) --
  
  The version of the runtime engine.
- environmentArn (string) --
  
  The Amazon Resource Name (ARN) of the runtime environment.
- environmentId (string) --
  
  The unique identifier of the runtime environment.
- highAvailabilityConfig (dict) --
  
  The desired capacity of the high availability configuration for the runtime environment.
  - desiredCapacity (integer) --
    
    The number of instances in a high availability configuration.
- instanceType (string) --
  
  The type of instance underlying the runtime environment.
- kmsKeyId (string) --
  
  The identifier of a customer managed key.
- loadBalancerArn (string) --
  
  The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
- name (string) --
  
  The name of the runtime environment. Must be unique within the account.
- pendingMaintenance (dict) --
  
  Indicates the pending maintenance scheduled on this environment.
  - engineVersion (string) --
    
    The specific runtime engine that the maintenance schedule applies to.
  - schedule (dict) --
    
    The maintenance schedule for the runtime engine version.
    - endTime (datetime) --
      
      The time the scheduled maintenance is to end.
    - startTime (datetime) --
      
      The time the scheduled maintenance is to start.
- preferredMaintenanceWindow (string) --
  
  Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
- publiclyAccessible (boolean) --
  
  Whether applications running in this runtime environment are publicly accessible.
- securityGroupIds (list) --
  
  The unique identifiers of the security groups assigned to this runtime environment.
  - (string) --
- status (string) --
  
  The status of the runtime environment.
- statusReason (string) --
  
  The reason for the reported status.
- storageConfigurations (list) --
  
  The storage configurations defined for the runtime environment.
  - (dict) --
    
    Defines the storage configuration for a runtime environment.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: efs, fsx. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - efs (dict) --
      
      Defines the storage configuration for an Amazon EFS file system.
      - fileSystemId (string) --
        
        The file system identifier.
      - mountPoint (string) --
        
        The mount point for the file system.
    - fsx (dict) --
      
      Defines the storage configuration for an Amazon FSx file system.
      - fileSystemId (string) --
        
        The file system identifier.
      - mountPoint (string) --
        
        The mount point for the file system.
- subnetIds (list) --
  
  The unique identifiers of the subnets assigned to this runtime environment.
  - (string) --
- tags (dict) --
  
  The tags defined for this runtime environment.
  - (string) --
    - (string) --
- vpcId (string) --
  
  The unique identifier for the VPC used with this runtime environment.

ListApplications (updated)

Link ¶
Changes (response)

{'applications': {'status': {'Deleting From Environment'}}}

Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    environmentId='string',
    maxResults=123,
    names=[
        'string',
    ],
    nextToken='string'
)

type environmentId

string

param environmentId

The unique identifier of the runtime environment where the applications are deployed.

type maxResults

integer

param maxResults

The maximum number of applications to return.

type names

list

param names

The names of the applications.

(string) --

type nextToken

string

param nextToken

A pagination token to control the number of applications displayed in the list.

rtype

dict

returns

Response Syntax

{
    'applications': [
        {
            'applicationArn': 'string',
            'applicationId': 'string',
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'deploymentStatus': 'Deploying'|'Deployed',
            'description': 'string',
            'engineType': 'microfocus'|'bluage',
            'environmentId': 'string',
            'lastStartTime': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'Creating'|'Created'|'Available'|'Ready'|'Starting'|'Running'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Deleting From Environment',
            'versionStatus': 'Creating'|'Available'|'Failed'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- applications (list) --
  
  Returns a list of summary details for all the applications in a runtime environment.
  - (dict) --
    
    A subset of the possible application attributes. Used in the application list.
    - applicationArn (string) --
      
      The Amazon Resource Name (ARN) of the application.
    - applicationId (string) --
      
      The unique identifier of the application.
    - applicationVersion (integer) --
      
      The version of the application.
    - creationTime (datetime) --
      
      The timestamp when the application was created.
    - deploymentStatus (string) --
      
      Indicates either an ongoing deployment or if the application has ever deployed successfully.
    - description (string) --
      
      The description of the application.
    - engineType (string) --
      
      The type of the target platform for this application.
    - environmentId (string) --
      
      The unique identifier of the runtime environment that hosts this application.
    - lastStartTime (datetime) --
      
      The timestamp when you last started the application. Null until the application runs for the first time.
    - name (string) --
      
      The name of the application.
    - status (string) --
      
      The status of the application.
    - versionStatus (string) --
      
      Indicates the status of the latest version of the application.
- nextToken (string) --
  
  A pagination token that's returned when the response doesn't contain all applications.

ListEnvironments (updated)

Link ¶
Changes (response)

{'environments': {'status': {'Updating'}}}

Lists the runtime environments.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    engineType='microfocus'|'bluage',
    maxResults=123,
    names=[
        'string',
    ],
    nextToken='string'
)

type engineType

string

param engineType

The engine type for the runtime environment.

type maxResults

integer

param maxResults

The maximum number of runtime environments to return.

type names

list

param names

The names of the runtime environments. Must be unique within the account.

(string) --

type nextToken

string

param nextToken

A pagination token to control the number of runtime environments displayed in the list.

rtype

dict

returns

Response Syntax

{
    'environments': [
        {
            'creationTime': datetime(2015, 1, 1),
            'engineType': 'microfocus'|'bluage',
            'engineVersion': 'string',
            'environmentArn': 'string',
            'environmentId': 'string',
            'instanceType': 'string',
            'name': 'string',
            'status': 'Creating'|'Available'|'Deleting'|'Failed'|'Updating'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- environments (list) --
  
  Returns a list of summary details for all the runtime environments in your account.
  - (dict) --
    
    Contains a subset of the possible runtime environment attributes. Used in the environment list.
    - creationTime (datetime) --
      
      The timestamp when the runtime environment was created.
    - engineType (string) --
      
      The target platform for the runtime environment.
    - engineVersion (string) --
      
      The version of the runtime engine.
    - environmentArn (string) --
      
      The Amazon Resource Name (ARN) of a particular runtime environment.
    - environmentId (string) --
      
      The unique identifier of a particular runtime environment.
    - instanceType (string) --
      
      The instance type of the runtime environment.
    - name (string) --
      
      The name of the runtime environment.
    - status (string) --
      
      The status of the runtime environment
- nextToken (string) --
  
  A pagination token that's returned when the response doesn't contain all the runtime environments.