Boolean allowDuplicates
Indicates whether the alternate key values are supposed to be unique for the given data set.
Integer length
A strictly positive integer value representing the length of the alternate key.
String name
The name of the alternate key.
Integer offset
A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
String applicationArn
The Amazon Resource Name (ARN) of the application.
String applicationId
The unique identifier of the application.
Integer applicationVersion
The version of the application.
Date creationTime
The timestamp when the application was created.
String deploymentStatus
Indicates either an ongoing deployment or if the application has ever deployed successfully.
String description
The description of the application.
String engineType
The type of the target platform for this application.
String environmentId
The unique identifier of the runtime environment that hosts this application.
Date lastStartTime
The timestamp when you last started the application. Null until the application runs for the first time.
String name
The name of the application.
String roleArn
The Amazon Resource Name (ARN) of the role associated with the application.
String status
The status of the application.
String versionStatus
Indicates the status of the latest version of the application.
FileBatchJobDefinition fileBatchJobDefinition
Specifies a file containing a batch job definition.
ScriptBatchJobDefinition scriptBatchJobDefinition
A script containing a batch job definition.
String applicationId
The unique identifier of the application that hosts this batch job.
BatchJobIdentifier batchJobIdentifier
The unique identifier of this batch job.
Date endTime
The timestamp when this batch job execution ended.
String executionId
The unique identifier of this execution of the batch job.
String jobId
The unique identifier of a particular batch job.
String jobName
The name of a particular batch job.
String jobType
The type of a particular batch job execution.
String returnCode
The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
Date startTime
The timestamp when a particular batch job execution started.
String status
The status of a particular batch job execution.
FileBatchJobIdentifier fileBatchJobIdentifier
Specifies a file associated with a specific batch job.
ScriptBatchJobIdentifier scriptBatchJobIdentifier
A batch job identifier in which the batch job to run is identified by the script name.
String 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.
Definition definition
The application definition for this application. You can specify either inline JSON or an S3 bucket location.
String description
The description of the application.
String engineType
The type of the target platform for this application.
String kmsKeyId
The identifier of a customer managed key.
String name
The unique identifier of the application.
String roleArn
The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.
Map<K,V> tags
A list of tags to apply to the application.
String applicationId
The unique identifier of the application for which you want to import data sets.
String 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.
DataSetImportConfig importConfig
The data set import task configuration.
String taskId
The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.
String applicationId
The application identifier.
Integer applicationVersion
The version of the application to deploy.
String 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.
String environmentId
The identifier of the runtime environment where you want to deploy this application.
String deploymentId
The unique identifier of the deployment.
String 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.
String description
The description of the runtime environment.
String engineType
The engine type for the runtime environment.
String engineVersion
The version of the engine type for the runtime environment.
HighAvailabilityConfig highAvailabilityConfig
The details of a high availability configuration for this runtime environment.
String instanceType
The type of instance for the runtime environment.
String kmsKeyId
The identifier of a customer managed key.
String name
The name of the runtime environment. Must be unique within the account.
String preferredMaintenanceWindow
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
Boolean publiclyAccessible
Specifies whether the runtime environment is publicly accessible.
List<E> securityGroupIds
The list of security groups for the VPC associated with this runtime environment.
List<E> storageConfigurations
Optional. The storage configurations for this runtime environment.
List<E> subnetIds
The list of subnets associated with the VPC for this runtime environment.
Map<K,V> tags
The tags for the runtime environment.
String environmentId
The unique identifier of the runtime environment.
String datasetName
The logical identifier for a specific data set (in mainframe format).
DatasetOrgAttributes datasetOrg
The type of dataset. The only supported value is VSAM.
RecordLength recordLength
The length of a record.
String relativePath
The relative location of the data set in the database or file system.
String 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.
GdgDetailAttributes gdg
The generation data group of the data set.
PoDetailAttributes po
The details of a PO type data set.
PsDetailAttributes ps
The details of a PS type data set.
VsamDetailAttributes vsam
The details of a VSAM data set.
DataSet dataSet
The data set.
ExternalLocation externalLocation
The location of the data set.
Integer failed
The number of data set imports that have failed.
Integer inProgress
The number of data set imports that are in progress.
Integer pending
The number of data set imports that are pending.
Integer succeeded
The number of data set imports that have succeeded.
Integer total
The total number of data set imports.
String status
The status of the data set import task.
DataSetImportSummary summary
A summary of the data set import task.
String taskId
The identifier of the data set import task.
GdgAttributes gdg
The generation data group of the data set.
PoAttributes po
The details of a PO type data set.
PsAttributes ps
The details of a PS type data set.
VsamAttributes vsam
The details of a VSAM data set.
Date creationTime
The timestamp when the data set was created.
String dataSetName
The name of the data set.
String dataSetOrg
The type of data set. The only supported value is VSAM.
String format
The format of the data set.
Date lastReferencedTime
The last time the data set was referenced.
Date lastUpdatedTime
The last time the data set was updated.
String applicationId
The unique identifier of the application you want to delete.
String environmentId
The unique identifier of the runtime environment you want to delete.
String applicationId
The unique identifier of the application.
Integer applicationVersion
The version of the application.
Date creationTime
The timestamp when the deployment was created.
String deploymentId
The unique identifier of the deployment.
String environmentId
The unique identifier of the runtime environment.
String status
The current status of the deployment.
String statusReason
The reason for the reported status.
Date creationTime
The timestamp when the runtime environment was created.
String engineType
The target platform for the runtime environment.
String engineVersion
The version of the runtime engine.
String environmentArn
The Amazon Resource Name (ARN) of a particular runtime environment.
String environmentId
The unique identifier of a particular runtime environment.
String instanceType
The instance type of the runtime environment.
String name
The name of the runtime environment.
String status
The status of the runtime environment
String s3Location
The URI of the Amazon S3 bucket.
String applicationId
The identifier of the application.
String applicationArn
The Amazon Resource Name (ARN) of the application.
String applicationId
The identifier of the application.
Date creationTime
The timestamp when this application was created.
DeployedVersionSummary deployedVersion
The version of the application that is deployed.
String description
The description of the application.
String engineType
The type of the target platform for the application.
String environmentId
The identifier of the runtime environment where you want to deploy the application.
String kmsKeyId
The identifier of a customer managed key.
Date lastStartTime
The timestamp when you last started the application. Null until the application runs for the first time.
ApplicationVersionSummary latestVersion
The latest version of the application.
List<E> 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 for you the first time you deploy an application.
List<E> listenerPorts
The port associated with the network load balancer listener created in your Amazon Web Services account.
String loadBalancerDnsName
The public DNS name of the load balancer created in your Amazon Web Services account.
List<E> logGroups
The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.
String name
The unique identifier of the application.
String roleArn
The Amazon Resource Name (ARN) of the role associated with the application.
String status
The status of the application.
String statusReason
The reason for the reported status.
Map<K,V> tags
A list of tags associated with the application.
List<E> targetGroupArns
Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
Integer applicationVersion
The specific version of the application.
Date creationTime
The timestamp when the application version was created.
String definitionContent
The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application.
String description
The application description.
String name
The name of the application version.
String status
The status of the application version.
String statusReason
The reason for the reported status.
String applicationId
The identifier of the application.
BatchJobIdentifier batchJobIdentifier
The unique identifier of this batch job.
Date endTime
The timestamp when the batch job execution ended.
String executionId
The unique identifier for this batch job execution.
String jobId
The unique identifier for this batch job.
String jobName
The name of this batch job.
String jobType
The type of job.
String jobUser
The user for the job.
String returnCode
The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
Date startTime
The timestamp when the batch job execution started.
String status
The status of the batch job execution.
String statusReason
The reason for the reported status.
Integer blocksize
The size of the block on disk.
Date creationTime
The timestamp when the data set was created.
String dataSetName
The name of the data set.
DatasetDetailOrgAttributes dataSetOrg
The type of data set. The only supported value is VSAM.
Date lastReferencedTime
The last time the data set was referenced.
Date lastUpdatedTime
The last time the data set was updated.
String location
The location where the data set is stored.
Integer recordLength
The length of records in the data set.
String applicationId
The application identifier.
String taskId
The task identifier returned by the CreateDataSetImportTask operation.
String status
The status of the task.
DataSetImportSummary summary
A summary of the status of the task.
String taskId
The task identifier.
String applicationId
The unique identifier of the application.
Integer applicationVersion
The application version.
Date creationTime
The timestamp when the deployment was created.
String deploymentId
The unique identifier of the deployment.
String environmentId
The unique identifier of the runtime environment.
String status
The status of the deployment.
String statusReason
The reason for the reported status.
String environmentId
The unique identifier of the runtime environment.
Integer 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.
Date creationTime
The timestamp when the runtime environment was created.
String description
The description of the runtime environment.
String engineType
The target platform for the runtime environment.
String engineVersion
The version of the runtime engine.
String environmentArn
The Amazon Resource Name (ARN) of the runtime environment.
String environmentId
The unique identifier of the runtime environment.
HighAvailabilityConfig highAvailabilityConfig
The desired capacity of the high availability configuration for the runtime environment.
String instanceType
The type of instance underlying the runtime environment.
String kmsKeyId
The identifier of a customer managed key.
String loadBalancerArn
The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
String name
The name of the runtime environment. Must be unique within the account.
PendingMaintenance pendingMaintenance
Indicates the pending maintenance scheduled on this environment.
String preferredMaintenanceWindow
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
Boolean publiclyAccessible
Whether applications running in this runtime environment are publicly accessible.
List<E> securityGroupIds
The unique identifiers of the security groups assigned to this runtime environment.
String status
The status of the runtime environment.
String statusReason
The reason for the reported status.
List<E> storageConfigurations
The storage configurations defined for the runtime environment.
List<E> subnetIds
The unique identifiers of the subnets assigned to this runtime environment.
Map<K,V> tags
The tags defined for this runtime environment.
String vpcId
The unique identifier for the VPC used with this runtime environment.
String signedBiUrl
Single sign-on AWS Blu Insights URL.
Integer desiredCapacity
The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
Integer retryAfterSeconds
The number of seconds to wait before retrying the request.
String environmentId
The unique identifier of the runtime environment where the applications are deployed.
Integer maxResults
The maximum number of applications to return.
List<E> names
The names of the applications.
String nextToken
A pagination token to control the number of applications displayed in the list.
String applicationId
The unique identifier of the application.
Integer maxResults
The maximum number of application versions to return.
String 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.
String applicationId
The identifier of the application.
Integer maxResults
The maximum number of batch job definitions to return.
String 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.
String prefix
If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
String applicationId
The unique identifier of the application.
List<E> executionIds
The unique identifier of each batch job execution.
String jobName
The name of each batch job execution.
Integer maxResults
The maximum number of batch job executions to return.
String nextToken
A pagination token to control the number of batch job executions displayed in the list.
Date startedAfter
The time after which the batch job executions started.
Date startedBefore
The time before the batch job executions started.
String status
The status of the batch job executions.
String applicationId
The unique identifier of the application.
Integer maxResults
The maximum number of objects to return.
String 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.
String applicationId
The unique identifier of the application for which you want to list the associated data sets.
Integer maxResults
The maximum number of objects to return.
String 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.
String prefix
The prefix of the data set name, which you can use to filter the list of data sets.
List<E> dataSets
The list of data sets, containing information including the creation time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.
String 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.
String applicationId
The application identifier.
Integer maxResults
The maximum number of objects to return.
String 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.
String engineType
The type of target platform.
Integer maxResults
The maximum number of objects to return.
String 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.
String engineType
The engine type for the runtime environment.
Integer maxResults
The maximum number of runtime environments to return.
List<E> names
The names of the runtime environments. Must be unique within the account.
String nextToken
A pagination token to control the number of runtime environments displayed in the list.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String engineVersion
The specific runtime engine that the maintenance schedule applies to.
MaintenanceSchedule schedule
The maintenance schedule for the runtime engine version.
String scriptName
The name of the script containing the batch job definition.
String scriptName
The name of the script containing the batch job definition.
String quotaCode
The identifier of the exceeded quota.
String resourceId
The ID of the resource that is exceeding the quota limit.
String resourceType
The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
String serviceCode
A code that identifies the service that the exceeded quota belongs to.
String applicationId
The unique identifier of the application you want to start.
String applicationId
The unique identifier of the application associated with this batch job.
BatchJobIdentifier batchJobIdentifier
The unique identifier of the batch job.
Map<K,V> jobParams
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
String executionId
The unique identifier of this execution of the batch job.
String applicationId
The unique identifier of the application you want to stop.
Boolean 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.
EfsStorageConfiguration efs
Defines the storage configuration for an Amazon EFS file system.
FsxStorageConfiguration fsx
Defines the storage configuration for an Amazon FSx file system.
String applicationId
The unique identifier of the application you want to update.
Integer currentApplicationVersion
The current version of the application to update.
Definition definition
The application definition for this application. You can specify either inline JSON or an S3 bucket location.
String description
The description of the application to update.
Integer applicationVersion
The new version of the application.
Boolean applyDuringMaintenanceWindow
Indicates whether to update the runtime 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.
Integer desiredCapacity
The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
String engineVersion
The version of the runtime engine for the runtime environment.
String environmentId
The unique identifier of the runtime environment that you want to update.
String instanceType
The instance type for the runtime environment to update.
String preferredMaintenanceWindow
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
String environmentId
The unique identifier of the runtime environment that was updated.
List<E> 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.
Boolean 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.
String encoding
The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
String format
The record format of the data set.
PrimaryKey primaryKey
The primary key of the data set.
List<E> 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.
Boolean cacheAtStartup
If set to True, enforces loading the data set into cache before it’s used by the application.
Boolean 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.
String encoding
The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
PrimaryKey primaryKey
The primary key of the data set.
String recordFormat
The record format of the data set.
Copyright © 2023. All rights reserved.