MainframeModernization

Client

class MainframeModernization.Client

A low-level client representing AWSMainframeModernization

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.

client = session.create_client('m2')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_batch_job_execution(**kwargs)

Cancels the running of a specific batch job execution.

See also: AWS API Documentation

Request Syntax

response = client.cancel_batch_job_execution(
    applicationId='string',
    executionId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • executionId (string) --

    [REQUIRED]

    The unique identifier of the batch job execution.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

close()

Closes underlying endpoint connections.

create_application(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    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.

  • definition (dict) --

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

  • description (string) -- The description of the application.
  • engineType (string) --

    [REQUIRED]

    The type of the target platform for this application.

  • name (string) --

    [REQUIRED]

    The unique identifier of the application.

  • tags (dict) --

    A list of tags to apply to the application.

    • (string) --
      • (string) --
Return type

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.

Exceptions

create_data_set_import_task(**kwargs)

Starts a data set import task for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.create_data_set_import_task(
    applicationId='string',
    clientToken='string',
    importConfig={
        'dataSets': [
            {
                'dataSet': {
                    'datasetName': 'string',
                    'datasetOrg': {
                        'gdg': {
                            'limit': 123,
                            'rollDisposition': 'string'
                        },
                        'vsam': {
                            'alternateKeys': [
                                {
                                    'allowDuplicates': True|False,
                                    'length': 123,
                                    'name': 'string',
                                    'offset': 123
                                },
                            ],
                            'compressed': True|False,
                            'encoding': 'string',
                            'format': 'string',
                            'primaryKey': {
                                'length': 123,
                                'name': 'string',
                                'offset': 123
                            }
                        }
                    },
                    'recordLength': {
                        'max': 123,
                        'min': 123
                    },
                    'relativePath': 'string',
                    'storageType': 'string'
                },
                'externalLocation': {
                    's3Location': 'string'
                }
            },
        ],
        's3Location': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application for which you want to import data sets.

  • clientToken (string) --

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. 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.

  • importConfig (dict) --

    [REQUIRED]

    The data set import task configuration.

    Note

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

    • dataSets (list) --

      The data sets.

      • (dict) --

        Identifies a specific data set to import from an external location.

        • dataSet (dict) -- [REQUIRED]

          The data set.

          • datasetName (string) -- [REQUIRED]

            The logical identifier for a specific data set (in mainframe format).

          • datasetOrg (dict) -- [REQUIRED]

            The type of dataset. Possible values include VSAM, IS, PS, GDG, PO, PS, UNKNOWN etc.

            Note

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

            • gdg (dict) --

              The generation data group of the data set.

              • limit (integer) --

                The maximum number of generation data sets, up to 255, in a GDG.

              • rollDisposition (string) --

                The disposition of the data set in the catalog.

            • vsam (dict) --

              The details of a VSAM data set.

              • alternateKeys (list) --

                The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

                • (dict) --

                  Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

                  • allowDuplicates (boolean) --

                    Indicates whether the alternate key values are supposed to be unique for the given data set.

                  • length (integer) -- [REQUIRED]

                    A strictly positive integer value representing the length of the alternate key.

                  • name (string) --

                    The name of the alternate key.

                  • offset (integer) -- [REQUIRED]

                    A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

              • compressed (boolean) --

                Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

              • encoding (string) --

                The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

              • format (string) -- [REQUIRED]

                The record format of the data set.

              • primaryKey (dict) --

                The primary key of the data set.

                • length (integer) -- [REQUIRED]

                  A strictly positive integer value representing the length of the primary key.

                • name (string) --

                  A name for the Primary Key.

                • offset (integer) -- [REQUIRED]

                  A positive integer value representing the offset to mark the start of the primary key in the record byte array.

          • recordLength (dict) -- [REQUIRED]

            The length of a record.

            • max (integer) -- [REQUIRED]

              The maximum record length. In case of fixed, both minimum and maximum are the same.

            • min (integer) -- [REQUIRED]

              The minimum record length of a record.

          • relativePath (string) --

            The relative location of the data set in the database or file system.

          • storageType (string) --

            The storage type of the data set: database or file system. For Micro Focus, database corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no support of file system and database corresponds to Blusam.

        • externalLocation (dict) -- [REQUIRED]

          The location of the data set.

          Note

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

          • s3Location (string) --

            The URI of the Amazon S3 bucket.

    • s3Location (string) --

      The Amazon S3 location of the data sets.

Return type

dict

Returns

Response Syntax

{
    'taskId': 'string'
}

Response Structure

  • (dict) --

    • taskId (string) --

      The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

Exceptions

create_deployment(**kwargs)

Creates and starts a deployment to deploy an application into an environment.

See also: AWS API Documentation

Request Syntax

response = client.create_deployment(
    applicationId='string',
    applicationVersion=123,
    clientToken='string',
    environmentId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The application identifier.

  • applicationVersion (integer) --

    [REQUIRED]

    The version of the application to deploy.

  • clientToken (string) --

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. 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.

  • environmentId (string) --

    [REQUIRED]

    The identifier of the environment where this application will be deployed.

Return type

dict

Returns

Response Syntax

{
    'deploymentId': 'string'
}

Response Structure

  • (dict) --

    • deploymentId (string) --

      The unique identifier of the deployment.

Exceptions

create_environment(**kwargs)

Creates a runtime environment for a given runtime engine.

See also: AWS API Documentation

Request Syntax

response = client.create_environment(
    clientToken='string',
    description='string',
    engineType='microfocus'|'bluage',
    engineVersion='string',
    highAvailabilityConfig={
        'desiredCapacity': 123
    },
    instanceType='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'
    }
)
Parameters
  • clientToken (string) --

    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.

  • description (string) -- The description of the environment.
  • engineType (string) --

    [REQUIRED]

    The engine type for the environment.

  • engineVersion (string) -- The version of the engine type for the environment.
  • highAvailabilityConfig (dict) --

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

    • desiredCapacity (integer) -- [REQUIRED]

      The number of instances in a high availability configuration.

  • instanceType (string) --

    [REQUIRED]

    The type of instance for the environment.

  • name (string) --

    [REQUIRED]

    The unique identifier of the environment.

  • preferredMaintenanceWindow (string) -- Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
  • publiclyAccessible (boolean) -- Specifies whether the environment is publicly accessible.
  • securityGroupIds (list) --

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

    • (string) --
  • storageConfigurations (list) --

    Optional. The storage configurations for this environment.

    • (dict) --

      Defines the storage configuration for an 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.

  • subnetIds (list) --

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

    • (string) --
  • tags (dict) --

    The tags for the environment.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

  • (dict) --

    • environmentId (string) --

      The identifier of this environment.

Exceptions

delete_application(**kwargs)

Deletes a specific application. You cannot delete a running application.

See also: AWS API Documentation

Request Syntax

response = client.delete_application(
    applicationId='string'
)
Parameters
applicationId (string) --

[REQUIRED]

The unique identifier of the application you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_application_from_environment(**kwargs)

Deletes a specific application from a specified environment where it has been previously deployed. You cannot delete an environment using DeleteEnvironment, if any application has ever been deployed to it. This API removes the association of the application with the environment so you can delete the environment smoothly.

See also: AWS API Documentation

Request Syntax

response = client.delete_application_from_environment(
    applicationId='string',
    environmentId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application you want to delete.

  • environmentId (string) --

    [REQUIRED]

    The unique identifier of the runtime environment where the application was previously deployed.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_environment(**kwargs)

Deletes a specific environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment(
    environmentId='string'
)
Parameters
environmentId (string) --

[REQUIRED]

The unique identifier of the runtime environment you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_application(**kwargs)

Describes the details of a specific application.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    applicationId='string'
)
Parameters
applicationId (string) --

[REQUIRED]

The identifier of the application.

Return type
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',
    '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',
    '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 environment where the application will be deployed.

    • lastStartTime (datetime) --

      The timestamp when the application was last started. Null until the application has started running 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 on your behalf 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. The Amazon Web Services Mainframe Modernization application log is pushed to CloudWatch under the customer's account.

      • (dict) --

        A subset of the attributes about 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) --

Exceptions

get_application_version(**kwargs)

Returns details about a specific version of a specific application.

See also: AWS API Documentation

Request Syntax

response = client.get_application_version(
    applicationId='string',
    applicationVersion=123
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • applicationVersion (integer) --

    [REQUIRED]

    The specific version of the application.

Return type

dict

Returns

Response Syntax

{
    'applicationVersion': 123,
    'creationTime': datetime(2015, 1, 1),
    'definitionContent': 'string',
    'description': 'string',
    'name': 'string',
    'status': 'Creating'|'Available'|'Failed',
    'statusReason': 'string'
}

Response Structure

  • (dict) --

    • applicationVersion (integer) --

      The specific version of the application.

    • creationTime (datetime) --

      The timestamp when the application version was created.

    • definitionContent (string) --

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

    • description (string) --

      The application description.

    • name (string) --

      The name of the application version.

    • status (string) --

      The status of the application version.

    • statusReason (string) --

      The reason for the reported status.

Exceptions

get_batch_job_execution(**kwargs)

Gets the details of a specific batch job execution for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.get_batch_job_execution(
    applicationId='string',
    executionId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The identifier of the application.

  • executionId (string) --

    [REQUIRED]

    The unique identifier of the batch job execution.

Return type

dict

Returns

Response Syntax

{
    'applicationId': 'string',
    'endTime': datetime(2015, 1, 1),
    'executionId': 'string',
    'jobId': 'string',
    'jobName': 'string',
    'jobType': 'VSE'|'JES2'|'JES3',
    'jobUser': 'string',
    'startTime': datetime(2015, 1, 1),
    'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning',
    'statusReason': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

      The identifier of the application.

    • endTime (datetime) --

      The timestamp when the batch job execution ended.

    • executionId (string) --

      The unique identifier for this batch job execution.

    • jobId (string) --

      The unique identifier for this batch job.

    • jobName (string) --

      The name of this batch job.

    • jobType (string) --

      The type of job.

    • jobUser (string) --

      The user for the job.

    • startTime (datetime) --

      The timestamp when the batch job execution started.

    • status (string) --

      The status of the batch job execution.

    • statusReason (string) --

      The reason for the reported status.

Exceptions

get_data_set_details(**kwargs)

Gets the details of a specific data set.

See also: AWS API Documentation

Request Syntax

response = client.get_data_set_details(
    applicationId='string',
    dataSetName='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application that this data set is associated with.

  • dataSetName (string) --

    [REQUIRED]

    The name of the data set.

Return type

dict

Returns

Response Syntax

{
    'blocksize': 123,
    'creationTime': datetime(2015, 1, 1),
    'dataSetName': 'string',
    'dataSetOrg': {
        'gdg': {
            'limit': 123,
            'rollDisposition': 'string'
        },
        'vsam': {
            'alternateKeys': [
                {
                    'allowDuplicates': True|False,
                    'length': 123,
                    'name': 'string',
                    'offset': 123
                },
            ],
            'cacheAtStartup': True|False,
            'compressed': True|False,
            'encoding': 'string',
            'primaryKey': {
                'length': 123,
                'name': 'string',
                'offset': 123
            },
            'recordFormat': 'string'
        }
    },
    'lastReferencedTime': datetime(2015, 1, 1),
    'lastUpdatedTime': datetime(2015, 1, 1),
    'location': 'string',
    'recordLength': 123
}

Response Structure

  • (dict) --

    • blocksize (integer) --

      The size of the block on disk.

    • creationTime (datetime) --

      The timestamp when the data set was created.

    • dataSetName (string) --

      The name of the data set.

    • dataSetOrg (dict) --

      The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: gdg, vsam. 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'}
      
      • gdg (dict) --

        The generation data group of the data set.

        • limit (integer) --

          The maximum number of generation data sets, up to 255, in a GDG.

        • rollDisposition (string) --

          The disposition of the data set in the catalog.

      • vsam (dict) --

        The details of a VSAM data set.

        • alternateKeys (list) --

          The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

          • (dict) --

            Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

            • allowDuplicates (boolean) --

              Indicates whether the alternate key values are supposed to be unique for the given data set.

            • length (integer) --

              A strictly positive integer value representing the length of the alternate key.

            • name (string) --

              The name of the alternate key.

            • offset (integer) --

              A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

        • cacheAtStartup (boolean) --

          If set to True, enforces loading the data set into cache before it’s used by the application.

        • compressed (boolean) --

          Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

        • encoding (string) --

          The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

        • primaryKey (dict) --

          The primary key of the data set.

          • length (integer) --

            A strictly positive integer value representing the length of the primary key.

          • name (string) --

            A name for the Primary Key.

          • offset (integer) --

            A positive integer value representing the offset to mark the start of the primary key in the record byte array.

        • recordFormat (string) --

          The record format of the data set.

    • lastReferencedTime (datetime) --

      The last time the data set was referenced.

    • lastUpdatedTime (datetime) --

      The last time the data set was updated.

    • location (string) --

      The locaion where the data set is stored.

    • recordLength (integer) --

      The length of records in the data set.

Exceptions

get_data_set_import_task(**kwargs)

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

See also: AWS API Documentation

Request Syntax

response = client.get_data_set_import_task(
    applicationId='string',
    taskId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The application identifier.

  • taskId (string) --

    [REQUIRED]

    The task identifier returned by the CreateDataSetImportTask operation.

Return type

dict

Returns

Response Syntax

{
    'status': 'Creating'|'Running'|'Completed',
    'summary': {
        'failed': 123,
        'inProgress': 123,
        'pending': 123,
        'succeeded': 123,
        'total': 123
    },
    'taskId': 'string'
}

Response Structure

  • (dict) --

    • status (string) --

      The status of the task.

    • summary (dict) --

      A summary of the status of the task.

      • failed (integer) --

        The number of data set imports that have failed.

      • inProgress (integer) --

        The number of data set imports that are in progress.

      • pending (integer) --

        The number of data set imports that are pending.

      • succeeded (integer) --

        The number of data set imports that have succeeded.

      • total (integer) --

        The total number of data set imports.

    • taskId (string) --

      The task identifier.

Exceptions

get_deployment(**kwargs)

Gets details of a specific deployment with a given deployment identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_deployment(
    applicationId='string',
    deploymentId='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • deploymentId (string) --

    [REQUIRED]

    The unique identifier for the deployment.

Return type

dict

Returns

Response Syntax

{
    'applicationId': 'string',
    'applicationVersion': 123,
    'creationTime': datetime(2015, 1, 1),
    'deploymentId': 'string',
    'environmentId': 'string',
    'status': 'Deploying'|'Succeeded'|'Failed',
    'statusReason': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

      The unique identifier of the application.

    • applicationVersion (integer) --

      The application version.

    • creationTime (datetime) --

      The timestamp when the deployment was created.

    • deploymentId (string) --

      The unique identifier of the deployment.

    • environmentId (string) --

      The unique identifier of the runtime environment.

    • status (string) --

      The status of the deployment.

    • statusReason (string) --

      The reason for the reported status.

Exceptions

get_environment(**kwargs)

Describes a specific runtime environment.

See also: AWS API Documentation

Request Syntax

response = client.get_environment(
    environmentId='string'
)
Parameters
environmentId (string) --

[REQUIRED]

The unique identifier of the runtime environment.

Return type
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',
    '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',
    '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.

    • loadBalancerArn (string) --

      The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

    • name (string) --

      The name of 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 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 a desired maintenance window for the 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 an 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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_application_versions(**kwargs)

Returns a list of the application versions for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.list_application_versions(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • maxResults (integer) -- The maximum number of application versions to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
Return type

dict

Returns

Response Syntax

{
    'applicationVersions': [
        {
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'status': 'Creating'|'Available'|'Failed',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • applicationVersions (list) --

      The list of application versions.

      • (dict) --

        Defines an application version summary.

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

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_applications(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    environmentId='string',
    maxResults=123,
    names=[
        'string',
    ],
    nextToken='string'
)
Parameters
  • environmentId (string) -- The unique identifier of the runtime environment where the applications are deployed.
  • maxResults (integer) -- The maximum number of applications to return.
  • names (list) --

    The names of the applications.

    • (string) --
  • nextToken (string) -- A pagination token to control the number of applications displayed in the list.
Return type

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',
            'versionStatus': 'Creating'|'Available'|'Failed'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • applications (list) --

      Returns a list of summary details for all the applications in an 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 whether there is 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 the application was last started. Null until the application has started running 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.

Exceptions

list_batch_job_definitions(**kwargs)

Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. The listed batch job definitions can then be used to start a batch job.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_job_definitions(
    applicationId='string',
    maxResults=123,
    nextToken='string',
    prefix='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The identifier of the application.

  • maxResults (integer) -- The maximum number of batch job definitions to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
  • prefix (string) -- If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
Return type

dict

Returns

Response Syntax

{
    'batchJobDefinitions': [
        {
            'fileBatchJobDefinition': {
                'fileName': 'string',
                'folderPath': 'string'
            },
            'scriptBatchJobDefinition': {
                'scriptName': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • batchJobDefinitions (list) --

      The list of batch job definitions.

      • (dict) --

        Defines the details of a batch job.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: fileBatchJobDefinition, scriptBatchJobDefinition. 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'}
        
        • fileBatchJobDefinition (dict) --

          Specifies a file containing a batch job definition.

          • fileName (string) --

            The name of the file containing the batch job definition.

          • folderPath (string) --

            The path to the file containing the batch job definition.

        • scriptBatchJobDefinition (dict) --

          A script containing a batch job definition.

          • scriptName (string) --

            The name of the script containing the batch job definition.

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_batch_job_executions(**kwargs)

Lists historical, current, and scheduled batch job executions for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_job_executions(
    applicationId='string',
    executionIds=[
        'string',
    ],
    jobName='string',
    maxResults=123,
    nextToken='string',
    startedAfter=datetime(2015, 1, 1),
    startedBefore=datetime(2015, 1, 1),
    status='Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • executionIds (list) --

    The unique identifier of each batch job execution.

    • (string) --
  • jobName (string) -- The name of each batch job execution.
  • maxResults (integer) -- The maximum number of batch job executions to return.
  • nextToken (string) -- A pagination token to control the number of batch job executions displayed in the list.
  • startedAfter (datetime) -- The time after which the batch job executions started.
  • startedBefore (datetime) -- The time before the batch job executions started.
  • status (string) -- The status of the batch job executions.
Return type

dict

Returns

Response Syntax

{
    'batchJobExecutions': [
        {
            'applicationId': 'string',
            'endTime': datetime(2015, 1, 1),
            'executionId': 'string',
            'jobId': 'string',
            'jobName': 'string',
            'jobType': 'VSE'|'JES2'|'JES3',
            'startTime': datetime(2015, 1, 1),
            'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • batchJobExecutions (list) --

      Returns a list of batch job executions for an application.

      • (dict) --

        A subset of the possible batch job attributes. Used in the batch job list.

        • applicationId (string) --

          The unique identifier of the application that hosts this batch job.

        • endTime (datetime) --

          The timestamp when this batch job execution ended.

        • executionId (string) --

          The unique identifier of this execution of the batch job.

        • jobId (string) --

          The unique identifier of a particular batch job.

        • jobName (string) --

          The name of a particular batch job.

        • jobType (string) --

          The type of a particular batch job execution.

        • startTime (datetime) --

          The timestamp when a particular batch job execution started.

        • status (string) --

          The status of a particular batch job execution.

    • nextToken (string) --

      A pagination token that's returned when the response doesn't contain all batch job executions.

Exceptions

list_data_set_import_history(**kwargs)

Lists the data set imports for the specified application.

See also: AWS API Documentation

Request Syntax

response = client.list_data_set_import_history(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • maxResults (integer) -- The maximum number of objects to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
Return type

dict

Returns

Response Syntax

{
    'dataSetImportTasks': [
        {
            'status': 'Creating'|'Running'|'Completed',
            'summary': {
                'failed': 123,
                'inProgress': 123,
                'pending': 123,
                'succeeded': 123,
                'total': 123
            },
            'taskId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • dataSetImportTasks (list) --

      The data set import tasks.

      • (dict) --

        Contains information about a data set import task.

        • status (string) --

          The status of the data set import task.

        • summary (dict) --

          A summary of the data set import task.

          • failed (integer) --

            The number of data set imports that have failed.

          • inProgress (integer) --

            The number of data set imports that are in progress.

          • pending (integer) --

            The number of data set imports that are pending.

          • succeeded (integer) --

            The number of data set imports that have succeeded.

          • total (integer) --

            The total number of data set imports.

        • taskId (string) --

          The identifier of the data set import task.

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_data_sets(**kwargs)

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask .

See also: AWS API Documentation

Request Syntax

response = client.list_data_sets(
    applicationId='string',
    maxResults=123,
    nextToken='string',
    prefix='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application for which you want to list the associated data sets.

  • maxResults (integer) -- The maximum number of objects to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
  • prefix (string) -- The prefix of the data set name, which you can use to filter the list of data sets.
Return type

dict

Returns

Response Syntax

{
    'dataSets': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataSetName': 'string',
            'dataSetOrg': 'string',
            'format': 'string',
            'lastReferencedTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • dataSets (list) --

      The list of data sets, containing ionformation including the creating time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.

      • (dict) --

        A subset of the possible data set attributes.

        • creationTime (datetime) --

          The timestamp when the data set was created.

        • dataSetName (string) --

          The name of the data set.

        • dataSetOrg (string) --

          The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

        • format (string) --

          The format of the data set.

        • lastReferencedTime (datetime) --

          The last time the data set was referenced.

        • lastUpdatedTime (datetime) --

          The last time the data set was updated.

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_deployments(**kwargs)

Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.

See also: AWS API Documentation

Request Syntax

response = client.list_deployments(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The application identifier.

  • maxResults (integer) -- The maximum number of objects to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
Return type

dict

Returns

Response Syntax

{
    'deployments': [
        {
            'applicationId': 'string',
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'deploymentId': 'string',
            'environmentId': 'string',
            'status': 'Deploying'|'Succeeded'|'Failed',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • deployments (list) --

      The list of deployments that is returned.

      • (dict) --

        A subset of information about a specific deployment.

        • applicationId (string) --

          The unique identifier of the application.

        • applicationVersion (integer) --

          The version of the application.

        • creationTime (datetime) --

          The timestamp when the deployment was created.

        • deploymentId (string) --

          The unique identifier of the deployment.

        • environmentId (string) --

          The unique identifier of the environment.

        • status (string) --

          The current status of the deployment.

        • statusReason (string) --

          The reason for the reported status.

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_engine_versions(**kwargs)

Lists the available engine versions.

See also: AWS API Documentation

Request Syntax

response = client.list_engine_versions(
    engineType='microfocus'|'bluage',
    maxResults=123,
    nextToken='string'
)
Parameters
  • engineType (string) -- The type of target platform.
  • maxResults (integer) -- The maximum number of objects to return.
  • nextToken (string) -- A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
Return type

dict

Returns

Response Syntax

{
    'engineVersions': [
        {
            'engineType': 'string',
            'engineVersion': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • engineVersions (list) --

      Returns the engine versions.

      • (dict) --

        A subset of information about the engine version for a specific application.

        • engineType (string) --

          The type of target platform for the application.

        • engineVersion (string) --

          The version of the engine type used by the application.

    • nextToken (string) --

      If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

list_environments(**kwargs)

Lists the runtime environments.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    engineType='microfocus'|'bluage',
    maxResults=123,
    names=[
        'string',
    ],
    nextToken='string'
)
Parameters
  • engineType (string) -- The engine type for the environment.
  • maxResults (integer) -- The maximum number of environments to return.
  • names (list) --

    The name of the environment.

    • (string) --
  • nextToken (string) -- A pagination token to control the number of environments displayed in the list.
Return type

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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • environments (list) --

      Returns a list of summary details for all the environments in your account.

      • (dict) --

        Contains a subset of the possible environment attributes. Used in the environment list.

        • creationTime (datetime) --

          The timestamp when the environment was created.

        • engineType (string) --

          The target platform for the 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 environment.

        • name (string) --

          The name of the environment.

        • status (string) --

          The status of the environment

    • nextToken (string) --

      A pagination token that's returned when the response doesn't contain all the environments.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The tags for the resource.

      • (string) --
        • (string) --

Exceptions

start_application(**kwargs)

Starts an application that is currently stopped.

See also: AWS API Documentation

Request Syntax

response = client.start_application(
    applicationId='string'
)
Parameters
applicationId (string) --

[REQUIRED]

The unique identifier of the application you want to start.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

start_batch_job(**kwargs)

Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.

See also: AWS API Documentation

Request Syntax

response = client.start_batch_job(
    applicationId='string',
    batchJobIdentifier={
        'fileBatchJobIdentifier': {
            'fileName': 'string',
            'folderPath': 'string'
        },
        'scriptBatchJobIdentifier': {
            'scriptName': 'string'
        }
    },
    jobParams={
        'string': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application associated with this batch job.

  • batchJobIdentifier (dict) --

    [REQUIRED]

    The unique identifier of the batch job.

    Note

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

    • fileBatchJobIdentifier (dict) --

      Specifies a file associated with a specific batch job.

      • fileName (string) -- [REQUIRED]

        The file name for the batch job identifier.

      • folderPath (string) --

        The relative path to the file name for the batch job identifier.

    • scriptBatchJobIdentifier (dict) --

      A batch job identifier in which the batch job to run is identified by the script name.

      • scriptName (string) -- [REQUIRED]

        The name of the script containing the batch job definition.

  • jobParams (dict) --

    The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL .

    • (string) --

      Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.

      • (string) --

        Parameter value can be of up to 44 alphanumeric characters.

Return type

dict

Returns

Response Syntax

{
    'executionId': 'string'
}

Response Structure

  • (dict) --

    • executionId (string) --

      The unique identifier of this execution of the batch job.

Exceptions

stop_application(**kwargs)

Stops a running application.

See also: AWS API Documentation

Request Syntax

response = client.stop_application(
    applicationId='string',
    forceStop=True|False
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application you want to stop.

  • forceStop (boolean) -- Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Adds one or more tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

    The tags to add to the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The keys of the tags to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_application(**kwargs)

Updates an application and creates a new version.

See also: AWS API Documentation

Request Syntax

response = client.update_application(
    applicationId='string',
    currentApplicationVersion=123,
    definition={
        'content': 'string',
        's3Location': 'string'
    },
    description='string'
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application you want to update.

  • currentApplicationVersion (integer) --

    [REQUIRED]

    The current version of the application to update.

  • definition (dict) --

    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.

  • description (string) -- The description of the application to update.
Return type

dict

Returns

Response Syntax

{
    'applicationVersion': 123
}

Response Structure

  • (dict) --

    • applicationVersion (integer) --

      The new version of the application.

Exceptions

update_environment(**kwargs)

Updates the configuration details for a specific environment.

See also: AWS API Documentation

Request Syntax

response = client.update_environment(
    applyDuringMaintenanceWindow=True|False,
    desiredCapacity=123,
    engineVersion='string',
    environmentId='string',
    instanceType='string',
    preferredMaintenanceWindow='string'
)
Parameters
  • applyDuringMaintenanceWindow (boolean) -- Indicates whether to update the environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest , it will fail if applyDuringMaintenanceWindow is set to true.
  • desiredCapacity (integer) -- The desired capacity for the environment to update.
  • engineVersion (string) -- The version of the runtime engine for the environment.
  • environmentId (string) --

    [REQUIRED]

    The unique identifier of the runtime environment that you want to update.

  • instanceType (string) -- The instance type for the environment to update.
  • preferredMaintenanceWindow (string) -- Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
Return type

dict

Returns

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

  • (dict) --

    • environmentId (string) --

      The unique identifier of the runtime environment that was updated.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class MainframeModernization.Client.exceptions.AccessDeniedException

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

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.ConflictException

The parameters provided in the request conflict with existing resources.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The parameters provided in the request conflict with existing resources.

    • message (string) --

    • resourceId (string) --

      The ID of the conflicting resource.

    • resourceType (string) --

      The type of the conflicting resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.InternalServerException

An unexpected error occurred during the processing of the request.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'retryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An unexpected error occurred during the processing of the request.

    • message (string) --

    • retryAfterSeconds (integer) --

      The number of seconds to wait before retrying the request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.ResourceNotFoundException

The specified resource was not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource was not found.

    • message (string) --

    • resourceId (string) --

      The ID of the missing resource.

    • resourceType (string) --

      The type of the missing resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.ServiceQuotaExceededException

One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

    • message (string) --

    • quotaCode (string) --

      The identifier of the exceeded quota.

    • resourceId (string) --

      The ID of the resource that is exceeding the quota limit.

    • resourceType (string) --

      The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.

    • serviceCode (string) --

      A code that identifies the service that the exceeded quota belongs to.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.ThrottlingException

The number of requests made exceeds the limit.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'retryAfterSeconds': 123,
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The number of requests made exceeds the limit.

    • message (string) --

    • quotaCode (string) --

      The identifier of the throttled reuqest.

    • retryAfterSeconds (integer) --

      The number of seconds to wait before retrying the request.

    • serviceCode (string) --

      The identifier of the service that the throttled request was made to.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MainframeModernization.Client.exceptions.ValidationException

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

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • fieldList (list) --

      The list of fields that failed service validation.

      • (dict) --

        Contains information about a validation exception field.

        • message (string) --

          The message of the exception field.

        • name (string) --

          The name of the exception field.

    • message (string) --

    • reason (string) --

      The reason why it failed service validation.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class MainframeModernization.Paginator.ListApplicationVersions
paginator = client.get_paginator('list_application_versions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_application_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'applicationVersions': [
        {
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'status': 'Creating'|'Available'|'Failed',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • applicationVersions (list) --

      The list of application versions.

      • (dict) --

        Defines an application version summary.

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

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListApplications
paginator = client.get_paginator('list_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentId='string',
    names=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • environmentId (string) -- The unique identifier of the runtime environment where the applications are deployed.
  • names (list) --

    The names of the applications.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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',
            'versionStatus': 'Creating'|'Available'|'Failed'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • applications (list) --

      Returns a list of summary details for all the applications in an 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 whether there is 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 the application was last started. Null until the application has started running 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 token to resume pagination.

class MainframeModernization.Paginator.ListBatchJobDefinitions
paginator = client.get_paginator('list_batch_job_definitions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_batch_job_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    prefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The identifier of the application.

  • prefix (string) -- If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'batchJobDefinitions': [
        {
            'fileBatchJobDefinition': {
                'fileName': 'string',
                'folderPath': 'string'
            },
            'scriptBatchJobDefinition': {
                'scriptName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • batchJobDefinitions (list) --

      The list of batch job definitions.

      • (dict) --

        Defines the details of a batch job.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: fileBatchJobDefinition, scriptBatchJobDefinition. 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'}
        
        • fileBatchJobDefinition (dict) --

          Specifies a file containing a batch job definition.

          • fileName (string) --

            The name of the file containing the batch job definition.

          • folderPath (string) --

            The path to the file containing the batch job definition.

        • scriptBatchJobDefinition (dict) --

          A script containing a batch job definition.

          • scriptName (string) --

            The name of the script containing the batch job definition.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListBatchJobExecutions
paginator = client.get_paginator('list_batch_job_executions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_batch_job_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    executionIds=[
        'string',
    ],
    jobName='string',
    startedAfter=datetime(2015, 1, 1),
    startedBefore=datetime(2015, 1, 1),
    status='Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • executionIds (list) --

    The unique identifier of each batch job execution.

    • (string) --
  • jobName (string) -- The name of each batch job execution.
  • startedAfter (datetime) -- The time after which the batch job executions started.
  • startedBefore (datetime) -- The time before the batch job executions started.
  • status (string) -- The status of the batch job executions.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'batchJobExecutions': [
        {
            'applicationId': 'string',
            'endTime': datetime(2015, 1, 1),
            'executionId': 'string',
            'jobId': 'string',
            'jobName': 'string',
            'jobType': 'VSE'|'JES2'|'JES3',
            'startTime': datetime(2015, 1, 1),
            'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • batchJobExecutions (list) --

      Returns a list of batch job executions for an application.

      • (dict) --

        A subset of the possible batch job attributes. Used in the batch job list.

        • applicationId (string) --

          The unique identifier of the application that hosts this batch job.

        • endTime (datetime) --

          The timestamp when this batch job execution ended.

        • executionId (string) --

          The unique identifier of this execution of the batch job.

        • jobId (string) --

          The unique identifier of a particular batch job.

        • jobName (string) --

          The name of a particular batch job.

        • jobType (string) --

          The type of a particular batch job execution.

        • startTime (datetime) --

          The timestamp when a particular batch job execution started.

        • status (string) --

          The status of a particular batch job execution.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListDataSetImportHistory
paginator = client.get_paginator('list_data_set_import_history')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_data_set_import_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'dataSetImportTasks': [
        {
            'status': 'Creating'|'Running'|'Completed',
            'summary': {
                'failed': 123,
                'inProgress': 123,
                'pending': 123,
                'succeeded': 123,
                'total': 123
            },
            'taskId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • dataSetImportTasks (list) --

      The data set import tasks.

      • (dict) --

        Contains information about a data set import task.

        • status (string) --

          The status of the data set import task.

        • summary (dict) --

          A summary of the data set import task.

          • failed (integer) --

            The number of data set imports that have failed.

          • inProgress (integer) --

            The number of data set imports that are in progress.

          • pending (integer) --

            The number of data set imports that are pending.

          • succeeded (integer) --

            The number of data set imports that have succeeded.

          • total (integer) --

            The total number of data set imports.

        • taskId (string) --

          The identifier of the data set import task.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListDataSets
paginator = client.get_paginator('list_data_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_data_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    prefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The unique identifier of the application for which you want to list the associated data sets.

  • prefix (string) -- The prefix of the data set name, which you can use to filter the list of data sets.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'dataSets': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataSetName': 'string',
            'dataSetOrg': 'string',
            'format': 'string',
            'lastReferencedTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • dataSets (list) --

      The list of data sets, containing ionformation including the creating time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.

      • (dict) --

        A subset of the possible data set attributes.

        • creationTime (datetime) --

          The timestamp when the data set was created.

        • dataSetName (string) --

          The name of the data set.

        • dataSetOrg (string) --

          The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

        • format (string) --

          The format of the data set.

        • lastReferencedTime (datetime) --

          The last time the data set was referenced.

        • lastUpdatedTime (datetime) --

          The last time the data set was updated.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListDeployments
paginator = client.get_paginator('list_deployments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • applicationId (string) --

    [REQUIRED]

    The application identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'deployments': [
        {
            'applicationId': 'string',
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'deploymentId': 'string',
            'environmentId': 'string',
            'status': 'Deploying'|'Succeeded'|'Failed',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • deployments (list) --

      The list of deployments that is returned.

      • (dict) --

        A subset of information about a specific deployment.

        • applicationId (string) --

          The unique identifier of the application.

        • applicationVersion (integer) --

          The version of the application.

        • creationTime (datetime) --

          The timestamp when the deployment was created.

        • deploymentId (string) --

          The unique identifier of the deployment.

        • environmentId (string) --

          The unique identifier of the environment.

        • status (string) --

          The current status of the deployment.

        • statusReason (string) --

          The reason for the reported status.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListEngineVersions
paginator = client.get_paginator('list_engine_versions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_engine_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    engineType='microfocus'|'bluage',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • engineType (string) -- The type of target platform.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'engineVersions': [
        {
            'engineType': 'string',
            'engineVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • engineVersions (list) --

      Returns the engine versions.

      • (dict) --

        A subset of information about the engine version for a specific application.

        • engineType (string) --

          The type of target platform for the application.

        • engineVersion (string) --

          The version of the engine type used by the application.

    • NextToken (string) --

      A token to resume pagination.

class MainframeModernization.Paginator.ListEnvironments
paginator = client.get_paginator('list_environments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    engineType='microfocus'|'bluage',
    names=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • engineType (string) -- The engine type for the environment.
  • names (list) --

    The name of the environment.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • environments (list) --

      Returns a list of summary details for all the environments in your account.

      • (dict) --

        Contains a subset of the possible environment attributes. Used in the environment list.

        • creationTime (datetime) --

          The timestamp when the environment was created.

        • engineType (string) --

          The target platform for the 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 environment.

        • name (string) --

          The name of the environment.

        • status (string) --

          The status of the environment

    • NextToken (string) --

      A token to resume pagination.