AWSMainframeModernization

2024/12/17 - AWSMainframeModernization - 3 updated api methods

Changes  This release adds support for AWS Mainframe Modernization(M2) Service to allow specifying network type(ipv4, dual) for the environment instances. For dual network type, m2 environment applications will serve both IPv4 and IPv6 requests, whereas for ipv4 it will serve only IPv4 requests.

CreateEnvironment (updated) Link ¶
Changes (request) 
{'networkType': 'ipv4 | dual'}

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',
    networkType='ipv4'|'dual',
    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. The minimum possible value is 1 and the maximum is 100.

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 networkType:

string

param networkType:

The network type required for the runtime environment.

type preferredMaintenanceWindow:

string

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

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

GetEnvironment (updated) Link ¶
Changes (response) 
{'networkType': 'ipv4 | dual'}

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',
    'networkType': 'ipv4'|'dual',
    'pendingMaintenance': {
        'engineVersion': 'string',
        'schedule': {
            'endTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1)
        }
    },
    'preferredMaintenanceWindow': 'string',
    'publiclyAccessible': True|False,
    'securityGroupIds': [
        'string',
    ],
    'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed'|'UnHealthy',
    '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 maximum 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. The minimum possible value is 1 and the maximum is 100.

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

    • networkType (string) --

      The network type supported by the runtime environment.

    • 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) --

      The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

    • 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. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.

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

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

ListEnvironments (updated) Link ¶
Changes (response) 
{'environments': {'networkType': 'ipv4 | dual'}}

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',
            'networkType': 'ipv4'|'dual',
            'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed'|'UnHealthy'
        },
    ],
    '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.

        • networkType (string) --

          The network type supported by 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.