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.
", "operations": { "CancelBatchJobExecution": "Cancels the running of a specific batch job execution.
", "CreateApplication": "Creates a new application with given parameters. Requires an existing environment and application definition file.
", "CreateDataSetImportTask": "Starts a data set import task for a specific application.
", "CreateDeployment": "Creates and starts a deployment to deploy an application into an environment.
", "CreateEnvironment": "Creates a runtime environment for a given runtime engine.
", "DeleteApplication": "Deletes a specific application. You cannot delete a running application.
", "DeleteApplicationFromEnvironment": "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.
", "DeleteEnvironment": "Deletes a specific environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
", "GetApplication": "Describes the details of a specific application.
", "GetApplicationVersion": "Returns details about a specific version of a specific application.
", "GetBatchJobExecution": "Gets the details of a specific batch job execution for a specific application.
", "GetDataSetDetails": "Gets the details of a specific data set.
", "GetDataSetImportTask": "Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
", "GetDeployment": "Gets details of a specific deployment with a given deployment identifier.
", "GetEnvironment": "Describes a specific runtime environment.
", "ListApplicationVersions": "Returns a list of the application versions for a specific application.
", "ListApplications": "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.
", "ListBatchJobDefinitions": "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.
", "ListBatchJobExecutions": "Lists historical, current, and scheduled batch job executions for a specific application.
", "ListDataSetImportHistory": "Lists the data set imports for the specified application.
", "ListDataSets": "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.
", "ListDeployments": "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.
", "ListEngineVersions": "Lists the available engine versions.
", "ListEnvironments": "Lists the runtime environments.
", "ListTagsForResource": "Lists the tags for the specified resource.
", "StartApplication": "Starts an application that is currently stopped.
", "StartBatchJob": "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.
", "StopApplication": "Stops a running application.
", "TagResource": "Adds one or more tags to the specified resource.
", "UntagResource": "Removes one or more tags from the specified resource.
", "UpdateApplication": "Updates an application and creates a new version.
", "UpdateEnvironment": "Updates the configuration details for a specific environment.
" }, "shapes": { "AccessDeniedException": { "base": "The account or role doesn't have the right permissions to make the request.
", "refs": { } }, "AlternateKey": { "base": "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.
", "refs": { "AlternateKeyList$member": null } }, "AlternateKeyList": { "base": null, "refs": { "VsamAttributes$alternateKeys": "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.
", "VsamDetailAttributes$alternateKeys": "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.
" } }, "ApplicationDeploymentLifecycle": { "base": null, "refs": { "ApplicationSummary$deploymentStatus": "Indicates whether there is an ongoing deployment or if the application has ever deployed successfully.
" } }, "ApplicationLifecycle": { "base": null, "refs": { "ApplicationSummary$status": "The status of the application.
", "GetApplicationResponse$status": "The status of the application.
" } }, "ApplicationSummary": { "base": "A subset of the possible application attributes. Used in the application list.
", "refs": { "ApplicationSummaryList$member": null } }, "ApplicationSummaryList": { "base": null, "refs": { "ListApplicationsResponse$applications": "Returns a list of summary details for all the applications in an environment.
" } }, "ApplicationVersionLifecycle": { "base": null, "refs": { "ApplicationSummary$versionStatus": "Indicates the status of the latest version of the application.
", "ApplicationVersionSummary$status": "The status of the application.
", "GetApplicationVersionResponse$status": "The status of the application version.
" } }, "ApplicationVersionSummary": { "base": "Defines an application version summary.
", "refs": { "ApplicationVersionSummaryList$member": null, "GetApplicationResponse$latestVersion": "The latest version of the application.
" } }, "ApplicationVersionSummaryList": { "base": null, "refs": { "ListApplicationVersionsResponse$applicationVersions": "The list of application versions.
" } }, "Arn": { "base": null, "refs": { "ApplicationSummary$applicationArn": "The Amazon Resource Name (ARN) of the application.
", "ArnList$member": null, "CreateApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the application.
", "EnvironmentSummary$environmentArn": "The Amazon Resource Name (ARN) of a particular runtime environment.
", "GetApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the application.
", "GetEnvironmentResponse$environmentArn": "The Amazon Resource Name (ARN) of the runtime environment.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "ArnList": { "base": null, "refs": { "GetApplicationResponse$listenerArns": "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.
", "GetApplicationResponse$targetGroupArns": "Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
" } }, "BatchJobDefinition": { "base": "Defines the details of a batch job.
", "refs": { "BatchJobDefinitions$member": null } }, "BatchJobDefinitions": { "base": null, "refs": { "ListBatchJobDefinitionsResponse$batchJobDefinitions": "The list of batch job definitions.
" } }, "BatchJobExecutionStatus": { "base": null, "refs": { "BatchJobExecutionSummary$status": "The status of a particular batch job execution.
", "GetBatchJobExecutionResponse$status": "The status of the batch job execution.
", "ListBatchJobExecutionsRequest$status": "The status of the batch job executions.
" } }, "BatchJobExecutionSummary": { "base": "A subset of the possible batch job attributes. Used in the batch job list.
", "refs": { "BatchJobExecutionSummaryList$member": null } }, "BatchJobExecutionSummaryList": { "base": null, "refs": { "ListBatchJobExecutionsResponse$batchJobExecutions": "Returns a list of batch job executions for an application.
" } }, "BatchJobIdentifier": { "base": "Identifies a specific batch job.
", "refs": { "StartBatchJobRequest$batchJobIdentifier": "The unique identifier of the batch job.
" } }, "BatchJobParametersMap": { "base": "Job parameters are optional. Can contain up to 500 entries.
", "refs": { "StartBatchJobRequest$jobParams": "The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
" } }, "BatchJobType": { "base": null, "refs": { "BatchJobExecutionSummary$jobType": "The type of a particular batch job execution.
", "GetBatchJobExecutionResponse$jobType": "The type of job.
" } }, "BatchParamKey": { "base": "Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.
", "refs": { "BatchJobParametersMap$key": null } }, "BatchParamValue": { "base": "Parameter value can be of up to 44 alphanumeric characters.
", "refs": { "BatchJobParametersMap$value": null } }, "Boolean": { "base": null, "refs": { "AlternateKey$allowDuplicates": "Indicates whether the alternate key values are supposed to be unique for the given data set.
", "CreateEnvironmentRequest$publiclyAccessible": "Specifies whether the environment is publicly accessible.
", "GetEnvironmentResponse$publiclyAccessible": "Whether applications running in this runtime environment are publicly accessible.
", "StopApplicationRequest$forceStop": "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.
", "UpdateEnvironmentRequest$applyDuringMaintenanceWindow": "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.
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.
", "VsamDetailAttributes$cacheAtStartup": "If set to True, enforces loading the data set into cache before it’s used by the application.
", "VsamDetailAttributes$compressed": "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.
" } }, "CancelBatchJobExecutionRequest": { "base": null, "refs": { } }, "CancelBatchJobExecutionResponse": { "base": null, "refs": { } }, "CapacityValue": { "base": null, "refs": { "GetEnvironmentResponse$actualCapacity": "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.
", "HighAvailabilityConfig$desiredCapacity": "The number of instances in a high availability configuration.
", "UpdateEnvironmentRequest$desiredCapacity": "The desired capacity for the environment to update.
" } }, "ConflictException": { "base": "The parameters provided in the request conflict with existing resources.
", "refs": { } }, "CreateApplicationRequest": { "base": null, "refs": { } }, "CreateApplicationResponse": { "base": null, "refs": { } }, "CreateDataSetImportTaskRequest": { "base": null, "refs": { } }, "CreateDataSetImportTaskResponse": { "base": null, "refs": { } }, "CreateDeploymentRequest": { "base": null, "refs": { } }, "CreateDeploymentResponse": { "base": null, "refs": { } }, "CreateEnvironmentRequest": { "base": null, "refs": { } }, "CreateEnvironmentResponse": { "base": null, "refs": { } }, "DataSet": { "base": "Defines a data set.
", "refs": { "DataSetImportItem$dataSet": "The data set.
" } }, "DataSetImportConfig": { "base": "Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.
", "refs": { "CreateDataSetImportTaskRequest$importConfig": "The data set import task configuration.
" } }, "DataSetImportItem": { "base": "Identifies a specific data set to import from an external location.
", "refs": { "DataSetImportList$member": null } }, "DataSetImportList": { "base": null, "refs": { "DataSetImportConfig$dataSets": "The data sets.
" } }, "DataSetImportSummary": { "base": "Represents a summary of data set imports.
", "refs": { "DataSetImportTask$summary": "A summary of the data set import task.
", "GetDataSetImportTaskResponse$summary": "A summary of the status of the task.
" } }, "DataSetImportTask": { "base": "Contains information about a data set import task.
", "refs": { "DataSetImportTaskList$member": null } }, "DataSetImportTaskList": { "base": null, "refs": { "ListDataSetImportHistoryResponse$dataSetImportTasks": "The data set import tasks.
" } }, "DataSetSummary": { "base": "A subset of the possible data set attributes.
", "refs": { "DataSetsSummaryList$member": null } }, "DataSetTaskLifecycle": { "base": null, "refs": { "DataSetImportTask$status": "The status of the data set import task.
", "GetDataSetImportTaskResponse$status": "The status of the task.
" } }, "DataSetsSummaryList": { "base": null, "refs": { "ListDataSetsResponse$dataSets": "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.
" } }, "DatasetDetailOrgAttributes": { "base": "Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).
", "refs": { "GetDataSetDetailsResponse$dataSetOrg": "The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.
" } }, "DatasetOrgAttributes": { "base": "Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).
", "refs": { "DataSet$datasetOrg": "The type of dataset. Possible values include VSAM, IS, PS, GDG, PO, PS, UNKNOWN etc.
" } }, "Definition": { "base": "The application definition for a particular application.
", "refs": { "CreateApplicationRequest$definition": "The application definition for this application. You can specify either inline JSON or an S3 bucket location.
", "UpdateApplicationRequest$definition": "The application definition for this application. You can specify either inline JSON or an S3 bucket location.
" } }, "DeleteApplicationFromEnvironmentRequest": { "base": null, "refs": { } }, "DeleteApplicationFromEnvironmentResponse": { "base": null, "refs": { } }, "DeleteApplicationRequest": { "base": null, "refs": { } }, "DeleteApplicationResponse": { "base": null, "refs": { } }, "DeleteEnvironmentRequest": { "base": null, "refs": { } }, "DeleteEnvironmentResponse": { "base": null, "refs": { } }, "DeployedVersionSummary": { "base": "Contains a summary of a deployed application.
", "refs": { "GetApplicationResponse$deployedVersion": "The version of the application that is deployed.
" } }, "DeploymentLifecycle": { "base": null, "refs": { "DeployedVersionSummary$status": "The status of the deployment.
", "DeploymentSummary$status": "The current status of the deployment.
", "GetDeploymentResponse$status": "The status of the deployment.
" } }, "DeploymentList": { "base": null, "refs": { "ListDeploymentsResponse$deployments": "The list of deployments that is returned.
" } }, "DeploymentSummary": { "base": "A subset of information about a specific deployment.
", "refs": { "DeploymentList$member": null } }, "EfsStorageConfiguration": { "base": "Defines the storage configuration for an Amazon EFS file system.
", "refs": { "StorageConfiguration$efs": "Defines the storage configuration for an Amazon EFS file system.
" } }, "EngineType": { "base": null, "refs": { "ApplicationSummary$engineType": "The type of the target platform for this application.
", "CreateApplicationRequest$engineType": "The type of the target platform for this application.
", "CreateEnvironmentRequest$engineType": "The engine type for the environment.
", "EnvironmentSummary$engineType": "The target platform for the environment.
", "GetApplicationResponse$engineType": "The type of the target platform for the application.
", "GetEnvironmentResponse$engineType": "The target platform for the runtime environment.
", "ListEngineVersionsRequest$engineType": "The type of target platform.
", "ListEnvironmentsRequest$engineType": "The engine type for the environment.
" } }, "EngineVersion": { "base": null, "refs": { "CreateEnvironmentRequest$engineVersion": "The version of the engine type for the environment.
", "EnvironmentSummary$engineVersion": "The version of the runtime engine.
", "GetEnvironmentResponse$engineVersion": "The version of the runtime engine.
", "UpdateEnvironmentRequest$engineVersion": "The version of the runtime engine for the environment.
" } }, "EngineVersionsSummary": { "base": "A subset of information about the engine version for a specific application.
", "refs": { "EngineVersionsSummaryList$member": null } }, "EngineVersionsSummaryList": { "base": null, "refs": { "ListEngineVersionsResponse$engineVersions": "Returns the engine versions.
" } }, "EntityDescription": { "base": null, "refs": { "ApplicationSummary$description": "The description of the application.
", "CreateApplicationRequest$description": "The description of the application.
", "CreateEnvironmentRequest$description": "The description of the environment.
", "GetApplicationResponse$description": "The description of the application.
", "GetApplicationVersionResponse$description": "The application description.
", "GetEnvironmentResponse$description": "The description of the runtime environment.
", "UpdateApplicationRequest$description": "The description of the application to update.
" } }, "EntityName": { "base": null, "refs": { "ApplicationSummary$name": "The name of the application.
", "CreateApplicationRequest$name": "The unique identifier of the application.
", "CreateEnvironmentRequest$name": "The unique identifier of the environment.
", "EntityNameList$member": null, "EnvironmentSummary$name": "The name of the environment.
", "GetApplicationResponse$name": "The unique identifier of the application.
", "GetApplicationVersionResponse$name": "The name of the application version.
", "GetEnvironmentResponse$name": "The name of the runtime environment.
" } }, "EntityNameList": { "base": null, "refs": { "ListApplicationsRequest$names": "The names of the applications.
", "ListEnvironmentsRequest$names": "The name of the environment.
" } }, "EnvironmentLifecycle": { "base": null, "refs": { "EnvironmentSummary$status": "The status of the environment
", "GetEnvironmentResponse$status": "The status of the runtime environment.
" } }, "EnvironmentSummary": { "base": "Contains a subset of the possible environment attributes. Used in the environment list.
", "refs": { "EnvironmentSummaryList$member": null } }, "EnvironmentSummaryList": { "base": null, "refs": { "ListEnvironmentsResponse$environments": "Returns a list of summary details for all the environments in your account.
" } }, "ExternalLocation": { "base": "Defines an external storage location.
", "refs": { "DataSetImportItem$externalLocation": "The location of the data set.
" } }, "FileBatchJobDefinition": { "base": "A file containing a batch job definition.
", "refs": { "BatchJobDefinition$fileBatchJobDefinition": "Specifies a file containing a batch job definition.
" } }, "FileBatchJobIdentifier": { "base": "A batch job identifier in which the batch job to run is identified by the file name and the relative path to the file name.
", "refs": { "BatchJobIdentifier$fileBatchJobIdentifier": "Specifies a file associated with a specific batch job.
" } }, "FsxStorageConfiguration": { "base": "Defines the storage configuration for an Amazon FSx file system.
", "refs": { "StorageConfiguration$fsx": "Defines the storage configuration for an Amazon FSx file system.
" } }, "GdgAttributes": { "base": "The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.
", "refs": { "DatasetOrgAttributes$gdg": "The generation data group of the data set.
" } }, "GdgDetailAttributes": { "base": "The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.
", "refs": { "DatasetDetailOrgAttributes$gdg": "The generation data group of the data set.
" } }, "GetApplicationRequest": { "base": null, "refs": { } }, "GetApplicationResponse": { "base": null, "refs": { } }, "GetApplicationVersionRequest": { "base": null, "refs": { } }, "GetApplicationVersionResponse": { "base": null, "refs": { } }, "GetBatchJobExecutionRequest": { "base": null, "refs": { } }, "GetBatchJobExecutionResponse": { "base": null, "refs": { } }, "GetDataSetDetailsRequest": { "base": null, "refs": { } }, "GetDataSetDetailsResponse": { "base": null, "refs": { } }, "GetDataSetImportTaskRequest": { "base": null, "refs": { } }, "GetDataSetImportTaskResponse": { "base": null, "refs": { } }, "GetDeploymentRequest": { "base": null, "refs": { } }, "GetDeploymentResponse": { "base": null, "refs": { } }, "GetEnvironmentRequest": { "base": null, "refs": { } }, "GetEnvironmentResponse": { "base": null, "refs": { } }, "HighAvailabilityConfig": { "base": "Defines the details of a high availability configuration.
", "refs": { "CreateEnvironmentRequest$highAvailabilityConfig": "The details of a high availability configuration for this runtime environment.
", "GetEnvironmentResponse$highAvailabilityConfig": "The desired capacity of the high availability configuration for the runtime environment.
" } }, "Identifier": { "base": null, "refs": { "ApplicationSummary$applicationId": "The unique identifier of the application.
", "ApplicationSummary$environmentId": "The unique identifier of the runtime environment that hosts this application.
", "BatchJobExecutionSummary$applicationId": "The unique identifier of the application that hosts this batch job.
", "BatchJobExecutionSummary$executionId": "The unique identifier of this execution of the batch job.
", "CancelBatchJobExecutionRequest$applicationId": "The unique identifier of the application.
", "CancelBatchJobExecutionRequest$executionId": "The unique identifier of the batch job execution.
", "CreateApplicationResponse$applicationId": "The unique application identifier.
", "CreateDataSetImportTaskRequest$applicationId": "The unique identifier of the application for which you want to import data sets.
", "CreateDataSetImportTaskResponse$taskId": "The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.
", "CreateDeploymentRequest$applicationId": "The application identifier.
", "CreateDeploymentRequest$environmentId": "The identifier of the environment where this application will be deployed.
", "CreateDeploymentResponse$deploymentId": "The unique identifier of the deployment.
", "CreateEnvironmentResponse$environmentId": "The identifier of this environment.
", "DataSetImportTask$taskId": "The identifier of the data set import task.
", "DeleteApplicationFromEnvironmentRequest$applicationId": "The unique identifier of the application you want to delete.
", "DeleteApplicationFromEnvironmentRequest$environmentId": "The unique identifier of the runtime environment where the application was previously deployed.
", "DeleteApplicationRequest$applicationId": "The unique identifier of the application you want to delete.
", "DeleteEnvironmentRequest$environmentId": "The unique identifier of the runtime environment you want to delete.
", "DeploymentSummary$applicationId": "The unique identifier of the application.
", "DeploymentSummary$deploymentId": "The unique identifier of the deployment.
", "DeploymentSummary$environmentId": "The unique identifier of the environment.
", "EnvironmentSummary$environmentId": "The unique identifier of a particular runtime environment.
", "GetApplicationRequest$applicationId": "The identifier of the application.
", "GetApplicationResponse$applicationId": "The identifier of the application.
", "GetApplicationResponse$environmentId": "The identifier of the environment where the application will be deployed.
", "GetApplicationVersionRequest$applicationId": "The unique identifier of the application.
", "GetBatchJobExecutionRequest$applicationId": "The identifier of the application.
", "GetBatchJobExecutionRequest$executionId": "The unique identifier of the batch job execution.
", "GetBatchJobExecutionResponse$applicationId": "The identifier of the application.
", "GetBatchJobExecutionResponse$executionId": "The unique identifier for this batch job execution.
", "GetDataSetDetailsRequest$applicationId": "The unique identifier of the application that this data set is associated with.
", "GetDataSetImportTaskRequest$applicationId": "The application identifier.
", "GetDataSetImportTaskRequest$taskId": "The task identifier returned by the CreateDataSetImportTask operation.
", "GetDataSetImportTaskResponse$taskId": "The task identifier.
", "GetDeploymentRequest$applicationId": "The unique identifier of the application.
", "GetDeploymentRequest$deploymentId": "The unique identifier for the deployment.
", "GetDeploymentResponse$applicationId": "The unique identifier of the application.
", "GetDeploymentResponse$deploymentId": "The unique identifier of the deployment.
", "GetDeploymentResponse$environmentId": "The unique identifier of the runtime environment.
", "GetEnvironmentRequest$environmentId": "The unique identifier of the runtime environment.
", "GetEnvironmentResponse$environmentId": "The unique identifier of the runtime environment.
", "IdentifierList$member": null, "ListApplicationVersionsRequest$applicationId": "The unique identifier of the application.
", "ListApplicationsRequest$environmentId": "The unique identifier of the runtime environment where the applications are deployed.
", "ListBatchJobDefinitionsRequest$applicationId": "The identifier of the application.
", "ListBatchJobExecutionsRequest$applicationId": "The unique identifier of the application.
", "ListDataSetImportHistoryRequest$applicationId": "The unique identifier of the application.
", "ListDataSetsRequest$applicationId": "The unique identifier of the application for which you want to list the associated data sets.
", "ListDeploymentsRequest$applicationId": "The application identifier.
", "StartApplicationRequest$applicationId": "The unique identifier of the application you want to start.
", "StartBatchJobRequest$applicationId": "The unique identifier of the application associated with this batch job.
", "StartBatchJobResponse$executionId": "The unique identifier of this execution of the batch job.
", "StopApplicationRequest$applicationId": "The unique identifier of the application you want to stop.
", "UpdateApplicationRequest$applicationId": "The unique identifier of the application you want to update.
", "UpdateEnvironmentRequest$environmentId": "The unique identifier of the runtime environment that you want to update.
", "UpdateEnvironmentResponse$environmentId": "The unique identifier of the runtime environment that was updated.
" } }, "IdentifierList": { "base": null, "refs": { "ListBatchJobExecutionsRequest$executionIds": "The unique identifier of each batch job execution.
" } }, "Integer": { "base": null, "refs": { "AlternateKey$length": "A strictly positive integer value representing the length of the alternate key.
", "AlternateKey$offset": "A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
", "DataSetImportSummary$failed": "The number of data set imports that have failed.
", "DataSetImportSummary$inProgress": "The number of data set imports that are in progress.
", "DataSetImportSummary$pending": "The number of data set imports that are pending.
", "DataSetImportSummary$succeeded": "The number of data set imports that have succeeded.
", "DataSetImportSummary$total": "The total number of data set imports.
", "GdgAttributes$limit": "The maximum number of generation data sets, up to 255, in a GDG.
", "GdgDetailAttributes$limit": "The maximum number of generation data sets, up to 255, in a GDG.
", "GetDataSetDetailsResponse$blocksize": "The size of the block on disk.
", "GetDataSetDetailsResponse$recordLength": "The length of records in the data set.
", "InternalServerException$retryAfterSeconds": "The number of seconds to wait before retrying the request.
", "PortList$member": null, "PrimaryKey$length": "A strictly positive integer value representing the length of the primary key.
", "PrimaryKey$offset": "A positive integer value representing the offset to mark the start of the primary key in the record byte array.
", "RecordLength$max": "The maximum record length. In case of fixed, both minimum and maximum are the same.
", "RecordLength$min": "The minimum record length of a record.
", "ThrottlingException$retryAfterSeconds": "The number of seconds to wait before retrying the request.
" } }, "InternalServerException": { "base": "An unexpected error occurred during the processing of the request.
", "refs": { } }, "ListApplicationVersionsRequest": { "base": null, "refs": { } }, "ListApplicationVersionsResponse": { "base": null, "refs": { } }, "ListApplicationsRequest": { "base": null, "refs": { } }, "ListApplicationsResponse": { "base": null, "refs": { } }, "ListBatchJobDefinitionsRequest": { "base": null, "refs": { } }, "ListBatchJobDefinitionsResponse": { "base": null, "refs": { } }, "ListBatchJobExecutionsRequest": { "base": null, "refs": { } }, "ListBatchJobExecutionsResponse": { "base": null, "refs": { } }, "ListDataSetImportHistoryRequest": { "base": null, "refs": { } }, "ListDataSetImportHistoryResponse": { "base": null, "refs": { } }, "ListDataSetsRequest": { "base": null, "refs": { } }, "ListDataSetsResponse": { "base": null, "refs": { } }, "ListDeploymentsRequest": { "base": null, "refs": { } }, "ListDeploymentsResponse": { "base": null, "refs": { } }, "ListEngineVersionsRequest": { "base": null, "refs": { } }, "ListEngineVersionsResponse": { "base": null, "refs": { } }, "ListEnvironmentsRequest": { "base": null, "refs": { } }, "ListEnvironmentsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "LogGroupIdentifier": { "base": null, "refs": { "LogGroupSummary$logGroupName": "The name of the log group.
" } }, "LogGroupSummaries": { "base": null, "refs": { "GetApplicationResponse$logGroups": "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.
" } }, "LogGroupSummary": { "base": "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.
", "refs": { "LogGroupSummaries$member": null } }, "MaintenanceSchedule": { "base": "The information about the maintenance schedule.
", "refs": { "PendingMaintenance$schedule": "The maintenance schedule for the engine version.
" } }, "MaxResults": { "base": null, "refs": { "ListApplicationVersionsRequest$maxResults": "The maximum number of application versions to return.
", "ListApplicationsRequest$maxResults": "The maximum number of applications to return.
", "ListBatchJobDefinitionsRequest$maxResults": "The maximum number of batch job definitions to return.
", "ListBatchJobExecutionsRequest$maxResults": "The maximum number of batch job executions to return.
", "ListDataSetImportHistoryRequest$maxResults": "The maximum number of objects to return.
", "ListDataSetsRequest$maxResults": "The maximum number of objects to return.
", "ListDeploymentsRequest$maxResults": "The maximum number of objects to return.
", "ListEngineVersionsRequest$maxResults": "The maximum number of objects to return.
", "ListEnvironmentsRequest$maxResults": "The maximum number of environments to return.
" } }, "NextToken": { "base": null, "refs": { "ListApplicationVersionsRequest$nextToken": "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.
", "ListApplicationVersionsResponse$nextToken": "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.
", "ListApplicationsRequest$nextToken": "A pagination token to control the number of applications displayed in the list.
", "ListApplicationsResponse$nextToken": "A pagination token that's returned when the response doesn't contain all applications.
", "ListBatchJobDefinitionsRequest$nextToken": "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.
", "ListBatchJobDefinitionsResponse$nextToken": "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.
", "ListBatchJobExecutionsRequest$nextToken": "A pagination token to control the number of batch job executions displayed in the list.
", "ListBatchJobExecutionsResponse$nextToken": "A pagination token that's returned when the response doesn't contain all batch job executions.
", "ListDataSetImportHistoryRequest$nextToken": "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.
", "ListDataSetImportHistoryResponse$nextToken": "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.
", "ListDataSetsRequest$nextToken": "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.
", "ListDataSetsResponse$nextToken": "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.
", "ListDeploymentsRequest$nextToken": "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.
", "ListDeploymentsResponse$nextToken": "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.
", "ListEngineVersionsRequest$nextToken": "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.
", "ListEngineVersionsResponse$nextToken": "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.
", "ListEnvironmentsRequest$nextToken": "A pagination token to control the number of environments displayed in the list.
", "ListEnvironmentsResponse$nextToken": "A pagination token that's returned when the response doesn't contain all the environments.
" } }, "PendingMaintenance": { "base": "The scheduled maintenance for a runtime engine.
", "refs": { "GetEnvironmentResponse$pendingMaintenance": "Indicates the pending maintenance scheduled on this environment.
" } }, "PortList": { "base": null, "refs": { "GetApplicationResponse$listenerPorts": "The port associated with the network load balancer listener created in your Amazon Web Services account.
" } }, "PrimaryKey": { "base": "The primary key for a KSDS data set.
", "refs": { "VsamAttributes$primaryKey": "The primary key of the data set.
", "VsamDetailAttributes$primaryKey": "The primary key of the data set.
" } }, "RecordLength": { "base": "The length of the records in the data set.
", "refs": { "DataSet$recordLength": "The length of a record.
" } }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", "refs": { } }, "ScriptBatchJobDefinition": { "base": "A batch job definition contained in a script.
", "refs": { "BatchJobDefinition$scriptBatchJobDefinition": "A script containing a batch job definition.
" } }, "ScriptBatchJobIdentifier": { "base": "A batch job identifier in which the batch job to run is identified by the script name.
", "refs": { "BatchJobIdentifier$scriptBatchJobIdentifier": "A batch job identifier in which the batch job to run is identified by the script name.
" } }, "ServiceQuotaExceededException": { "base": "One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
", "refs": { } }, "StartApplicationRequest": { "base": null, "refs": { } }, "StartApplicationResponse": { "base": null, "refs": { } }, "StartBatchJobRequest": { "base": null, "refs": { } }, "StartBatchJobResponse": { "base": null, "refs": { } }, "StopApplicationRequest": { "base": null, "refs": { } }, "StopApplicationResponse": { "base": null, "refs": { } }, "StorageConfiguration": { "base": "Defines the storage configuration for an environment.
", "refs": { "StorageConfigurationList$member": null } }, "StorageConfigurationList": { "base": null, "refs": { "CreateEnvironmentRequest$storageConfigurations": "Optional. The storage configurations for this environment.
", "GetEnvironmentResponse$storageConfigurations": "The storage configurations defined for the runtime environment.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "AlternateKey$name": "The name of the alternate key.
", "ApplicationVersionSummary$statusReason": "The reason for the reported status.
", "ConflictException$message": null, "ConflictException$resourceId": "The ID of the conflicting resource.
", "ConflictException$resourceType": "The type of the conflicting resource.
", "CreateApplicationRequest$clientToken": "Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", "CreateDataSetImportTaskRequest$clientToken": "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.
", "CreateDeploymentRequest$clientToken": "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.
", "CreateEnvironmentRequest$clientToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", "DataSet$datasetName": "The logical identifier for a specific data set (in mainframe format).
", "DataSet$relativePath": "The relative location of the data set in the database or file system.
", "DataSet$storageType": "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.
", "DeployedVersionSummary$statusReason": "The reason for the reported status.
", "DeploymentSummary$statusReason": "The reason for the reported status.
", "EngineVersionsSummary$engineType": "The type of target platform for the application.
", "EngineVersionsSummary$engineVersion": "The version of the engine type used by the application.
", "FileBatchJobDefinition$fileName": "The name of the file containing the batch job definition.
", "FileBatchJobDefinition$folderPath": "The path to the file containing the batch job definition.
", "FileBatchJobIdentifier$fileName": "The file name for the batch job identifier.
", "FileBatchJobIdentifier$folderPath": "The relative path to the file name for the batch job identifier.
", "GdgAttributes$rollDisposition": "The disposition of the data set in the catalog.
", "GetApplicationResponse$statusReason": "The reason for the reported status.
", "GetApplicationVersionResponse$statusReason": "The reason for the reported status.
", "GetBatchJobExecutionResponse$statusReason": "The reason for the reported status.
", "GetDeploymentResponse$statusReason": "The reason for the reported status.
", "GetEnvironmentResponse$loadBalancerArn": "The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
", "GetEnvironmentResponse$preferredMaintenanceWindow": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
", "GetEnvironmentResponse$statusReason": "The reason for the reported status.
", "InternalServerException$message": null, "ListBatchJobDefinitionsRequest$prefix": "If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
", "PendingMaintenance$engineVersion": "The specific runtime engine that the maintenance schedule applies to.
", "PrimaryKey$name": "A name for the Primary Key.
", "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The ID of the missing resource.
", "ResourceNotFoundException$resourceType": "The type of the missing resource.
", "ScriptBatchJobDefinition$scriptName": "The name of the script containing the batch job definition.
", "ScriptBatchJobIdentifier$scriptName": "The name of the script containing the batch job definition.
", "ServiceQuotaExceededException$message": null, "ServiceQuotaExceededException$quotaCode": "The identifier of the exceeded quota.
", "ServiceQuotaExceededException$resourceId": "The ID of the resource that is exceeding the quota limit.
", "ServiceQuotaExceededException$resourceType": "The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
", "ServiceQuotaExceededException$serviceCode": "A code that identifies the service that the exceeded quota belongs to.
", "ThrottlingException$message": null, "ThrottlingException$quotaCode": "The identifier of the throttled reuqest.
", "ThrottlingException$serviceCode": "The identifier of the service that the throttled request was made to.
", "UpdateEnvironmentRequest$preferredMaintenanceWindow": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
", "ValidationException$message": null, "ValidationExceptionField$message": "The message of the exception field.
", "ValidationExceptionField$name": "The name of the exception field.
", "VsamAttributes$encoding": "The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
", "VsamAttributes$format": "The record format of the data set.
" } }, "String100": { "base": null, "refs": { "BatchJobExecutionSummary$jobId": "The unique identifier of a particular batch job.
", "BatchJobExecutionSummary$jobName": "The name of a particular batch job.
", "GetApplicationResponse$loadBalancerDnsName": "The public DNS name of the load balancer created in your Amazon Web Services account.
", "GetBatchJobExecutionResponse$jobId": "The unique identifier for this batch job.
", "GetBatchJobExecutionResponse$jobName": "The name of this batch job.
", "GetBatchJobExecutionResponse$jobUser": "The user for the job.
", "ListBatchJobExecutionsRequest$jobName": "The name of each batch job execution.
" } }, "String20": { "base": null, "refs": { "CreateEnvironmentRequest$instanceType": "The type of instance for the environment.
", "DataSetSummary$dataSetOrg": "The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.
", "DataSetSummary$format": "The format of the data set.
", "EnvironmentSummary$instanceType": "The instance type of the environment.
", "GetEnvironmentResponse$instanceType": "The type of instance underlying the runtime environment.
", "LogGroupSummary$logType": "The type of log.
", "UpdateEnvironmentRequest$instanceType": "The instance type for the environment to update.
", "VsamDetailAttributes$encoding": "The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
", "VsamDetailAttributes$recordFormat": "The record format of the data set.
" } }, "String200": { "base": null, "refs": { "DataSetSummary$dataSetName": "The name of the data set.
", "EfsStorageConfiguration$fileSystemId": "The file system identifier.
", "EfsStorageConfiguration$mountPoint": "The mount point for the file system.
", "FsxStorageConfiguration$fileSystemId": "The file system identifier.
", "FsxStorageConfiguration$mountPoint": "The mount point for the file system.
", "GetDataSetDetailsRequest$dataSetName": "The name of the data set.
", "GetDataSetDetailsResponse$dataSetName": "The name of the data set.
", "ListDataSetsRequest$prefix": "The prefix of the data set name, which you can use to filter the list of data sets.
" } }, "String2000": { "base": null, "refs": { "DataSetImportConfig$s3Location": "The Amazon S3 location of the data sets.
", "Definition$s3Location": "The S3 bucket that contains the application definition.
", "ExternalLocation$s3Location": "The URI of the Amazon S3 bucket.
", "GetDataSetDetailsResponse$location": "The locaion where the data set is stored.
" } }, "String50": { "base": null, "refs": { "CreateEnvironmentRequest$preferredMaintenanceWindow": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
", "GdgDetailAttributes$rollDisposition": "The disposition of the data set in the catalog.
", "GetEnvironmentResponse$vpcId": "The unique identifier for the VPC used with this runtime environment.
", "String50List$member": null } }, "String50List": { "base": null, "refs": { "CreateEnvironmentRequest$securityGroupIds": "The list of security groups for the VPC associated with this environment.
", "CreateEnvironmentRequest$subnetIds": "The list of subnets associated with the VPC for this environment.
", "GetEnvironmentResponse$securityGroupIds": "The unique identifiers of the security groups assigned to this runtime environment.
", "GetEnvironmentResponse$subnetIds": "The unique identifiers of the subnets assigned to this runtime environment.
" } }, "StringFree65000": { "base": null, "refs": { "Definition$content": "The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.
", "GetApplicationVersionResponse$definitionContent": "The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The keys of the tags to remove.
" } }, "TagMap": { "base": null, "refs": { "CreateApplicationRequest$tags": "A list of tags to apply to the application.
", "CreateEnvironmentRequest$tags": "The tags for the environment.
", "GetApplicationResponse$tags": "A list of tags associated with the application.
", "GetEnvironmentResponse$tags": "The tags defined for this runtime environment.
", "ListTagsForResourceResponse$tags": "The tags for the resource.
", "TagResourceRequest$tags": "The tags to add to the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "ThrottlingException": { "base": "The number of requests made exceeds the limit.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "ApplicationSummary$creationTime": "The timestamp when the application was created.
", "ApplicationSummary$lastStartTime": "The timestamp when the application was last started. Null until the application has started running for the first time.
", "ApplicationVersionSummary$creationTime": "The timestamp when the application version was created.
", "BatchJobExecutionSummary$endTime": "The timestamp when this batch job execution ended.
", "BatchJobExecutionSummary$startTime": "The timestamp when a particular batch job execution started.
", "DataSetSummary$creationTime": "The timestamp when the data set was created.
", "DataSetSummary$lastReferencedTime": "The last time the data set was referenced.
", "DataSetSummary$lastUpdatedTime": "The last time the data set was updated.
", "DeploymentSummary$creationTime": "The timestamp when the deployment was created.
", "EnvironmentSummary$creationTime": "The timestamp when the environment was created.
", "GetApplicationResponse$creationTime": "The timestamp when this application was created.
", "GetApplicationResponse$lastStartTime": "The timestamp when the application was last started. Null until the application has started running for the first time.
", "GetApplicationVersionResponse$creationTime": "The timestamp when the application version was created.
", "GetBatchJobExecutionResponse$endTime": "The timestamp when the batch job execution ended.
", "GetBatchJobExecutionResponse$startTime": "The timestamp when the batch job execution started.
", "GetDataSetDetailsResponse$creationTime": "The timestamp when the data set was created.
", "GetDataSetDetailsResponse$lastReferencedTime": "The last time the data set was referenced.
", "GetDataSetDetailsResponse$lastUpdatedTime": "The last time the data set was updated.
", "GetDeploymentResponse$creationTime": "The timestamp when the deployment was created.
", "GetEnvironmentResponse$creationTime": "The timestamp when the runtime environment was created.
", "ListBatchJobExecutionsRequest$startedAfter": "The time after which the batch job executions started.
", "ListBatchJobExecutionsRequest$startedBefore": "The time before the batch job executions started.
", "MaintenanceSchedule$endTime": "The time the scheduled maintenance is to end.
", "MaintenanceSchedule$startTime": "The time the scheduled maintenance is to start.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateApplicationRequest": { "base": null, "refs": { } }, "UpdateApplicationResponse": { "base": null, "refs": { } }, "UpdateEnvironmentRequest": { "base": null, "refs": { } }, "UpdateEnvironmentResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "One or more parameters provided in the request is not valid.
", "refs": { } }, "ValidationExceptionField": { "base": "Contains information about a validation exception field.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The list of fields that failed service validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason why it failed service validation.
" } }, "Version": { "base": null, "refs": { "ApplicationSummary$applicationVersion": "The version of the application.
", "ApplicationVersionSummary$applicationVersion": "The application version.
", "CreateApplicationResponse$applicationVersion": "The version number of the application.
", "CreateDeploymentRequest$applicationVersion": "The version of the application to deploy.
", "DeployedVersionSummary$applicationVersion": "The version of the deployed application.
", "DeploymentSummary$applicationVersion": "The version of the application.
", "GetApplicationVersionRequest$applicationVersion": "The specific version of the application.
", "GetApplicationVersionResponse$applicationVersion": "The specific version of the application.
", "GetDeploymentResponse$applicationVersion": "The application version.
", "UpdateApplicationRequest$currentApplicationVersion": "The current version of the application to update.
", "UpdateApplicationResponse$applicationVersion": "The new version of the application.
" } }, "VsamAttributes": { "base": "The attributes of a VSAM type data set.
", "refs": { "DatasetOrgAttributes$vsam": "The details of a VSAM data set.
" } }, "VsamDetailAttributes": { "base": "The attributes of a VSAM type data set.
", "refs": { "DatasetDetailOrgAttributes$vsam": "The details of a VSAM data set.
" } } } }