2023/10/31 - AWSMainframeModernization - 11 updated api methods
Changes Added name filter ability for ListDataSets API, added ForceUpdate for Updating environment and BatchJob submission using S3BatchJobIdentifier
{'deployedVersion': {'status': {'Updating Deployment'}}}
Describes the details of a specific application.
See also: AWS API Documentation
Request Syntax
client.get_application(
applicationId='string'
)
string
[REQUIRED]
The identifier of the application.
dict
Response Syntax
{
'applicationArn': 'string',
'applicationId': 'string',
'creationTime': datetime(2015, 1, 1),
'deployedVersion': {
'applicationVersion': 123,
'status': 'Deploying'|'Succeeded'|'Failed'|'Updating Deployment',
'statusReason': 'string'
},
'description': 'string',
'engineType': 'microfocus'|'bluage',
'environmentId': 'string',
'kmsKeyId': 'string',
'lastStartTime': datetime(2015, 1, 1),
'latestVersion': {
'applicationVersion': 123,
'creationTime': datetime(2015, 1, 1),
'status': 'Creating'|'Available'|'Failed',
'statusReason': 'string'
},
'listenerArns': [
'string',
],
'listenerPorts': [
123,
],
'loadBalancerDnsName': 'string',
'logGroups': [
{
'logGroupName': 'string',
'logType': 'string'
},
],
'name': 'string',
'roleArn': 'string',
'status': 'Creating'|'Created'|'Available'|'Ready'|'Starting'|'Running'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Deleting From Environment',
'statusReason': 'string',
'tags': {
'string': 'string'
},
'targetGroupArns': [
'string',
]
}
Response Structure
(dict) --
applicationArn (string) --
The Amazon Resource Name (ARN) of the application.
applicationId (string) --
The identifier of the application.
creationTime (datetime) --
The timestamp when this application was created.
deployedVersion (dict) --
The version of the application that is deployed.
applicationVersion (integer) --
The version of the deployed application.
status (string) --
The status of the deployment.
statusReason (string) --
The reason for the reported status.
description (string) --
The description of the application.
engineType (string) --
The type of the target platform for the application.
environmentId (string) --
The identifier of the runtime environment where you want to deploy the application.
kmsKeyId (string) --
The identifier of a customer managed key.
lastStartTime (datetime) --
The timestamp when you last started the application. Null until the application runs for the first time.
latestVersion (dict) --
The latest version of the application.
applicationVersion (integer) --
The application version.
creationTime (datetime) --
The timestamp when the application version was created.
status (string) --
The status of the application.
statusReason (string) --
The reason for the reported status.
listenerArns (list) --
The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.
(string) --
listenerPorts (list) --
The port associated with the network load balancer listener created in your Amazon Web Services account.
(integer) --
loadBalancerDnsName (string) --
The public DNS name of the load balancer created in your Amazon Web Services account.
logGroups (list) --
The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.
(dict) --
A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.
logGroupName (string) --
The name of the log group.
logType (string) --
The type of log.
name (string) --
The unique identifier of the application.
roleArn (string) --
The Amazon Resource Name (ARN) of the role associated with 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) --
{'batchJobIdentifier': {'s3BatchJobIdentifier': {'bucket': 'string',
'identifier': {'fileName': 'string',
'scriptName': 'string'},
'keyPrefix': 'string'}}}
Gets the details of a specific batch job execution for a specific application.
See also: AWS API Documentation
Request Syntax
client.get_batch_job_execution(
applicationId='string',
executionId='string'
)
string
[REQUIRED]
The identifier of the application.
string
[REQUIRED]
The unique identifier of the batch job execution.
dict
Response Syntax
{
'applicationId': 'string',
'batchJobIdentifier': {
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
's3BatchJobIdentifier': {
'bucket': 'string',
'identifier': {
'fileName': 'string',
'scriptName': 'string'
},
'keyPrefix': 'string'
},
'scriptBatchJobIdentifier': {
'scriptName': 'string'
}
},
'endTime': datetime(2015, 1, 1),
'executionId': 'string',
'jobId': 'string',
'jobName': 'string',
'jobType': 'VSE'|'JES2'|'JES3',
'jobUser': 'string',
'returnCode': '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.
batchJobIdentifier (dict) --
The unique identifier of this batch job.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fileBatchJobIdentifier, s3BatchJobIdentifier, scriptBatchJobIdentifier. 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'}
fileBatchJobIdentifier (dict) --
Specifies a file associated with a specific batch job.
fileName (string) --
The file name for the batch job identifier.
folderPath (string) --
The relative path to the file name for the batch job identifier.
s3BatchJobIdentifier (dict) --
Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
bucket (string) --
The Amazon S3 bucket that contains the batch job definitions.
identifier (dict) --
Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fileName, scriptName. 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'}
fileName (string) --
The name of the file that contains the batch job definition.
scriptName (string) --
The name of the script that contains the batch job definition.
keyPrefix (string) --
The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
scriptBatchJobIdentifier (dict) --
A batch job identifier in which the batch job to run is identified by the script name.
scriptName (string) --
The name of the script containing the batch job definition.
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.
returnCode (string) --
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.
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.
{'fileSize': 'long'}
Gets the details of a specific data set.
See also: AWS API Documentation
Request Syntax
client.get_data_set_details(
applicationId='string',
dataSetName='string'
)
string
[REQUIRED]
The unique identifier of the application that this data set is associated with.
string
[REQUIRED]
The name of the data set.
dict
Response Syntax
{
'blocksize': 123,
'creationTime': datetime(2015, 1, 1),
'dataSetName': 'string',
'dataSetOrg': {
'gdg': {
'limit': 123,
'rollDisposition': 'string'
},
'po': {
'encoding': 'string',
'format': 'string'
},
'ps': {
'encoding': 'string',
'format': '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'
}
},
'fileSize': 123,
'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. The only supported value is VSAM.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: gdg, po, ps, 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.
po (dict) --
The details of a PO type data set.
encoding (string) --
The character set encoding of the data set.
format (string) --
The format of the data set records.
ps (dict) --
The details of a PS type data set.
encoding (string) --
The character set encoding of the data set.
format (string) --
The format of the data set records.
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.
fileSize (integer) --
File size of the dataset.
lastReferencedTime (datetime) --
The last time the data set was referenced.
lastUpdatedTime (datetime) --
The last time the data set was updated.
location (string) --
The location where the data set is stored.
recordLength (integer) --
The length of records in the data set.
{'status': {'Failed'}}
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
See also: AWS API Documentation
Request Syntax
client.get_data_set_import_task(
applicationId='string',
taskId='string'
)
string
[REQUIRED]
The application identifier.
string
[REQUIRED]
The task identifier returned by the CreateDataSetImportTask operation.
dict
Response Syntax
{
'status': 'Creating'|'Running'|'Completed'|'Failed',
'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.
{'status': {'Updating Deployment'}}
Gets details of a specific deployment with a given deployment identifier.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
applicationId='string',
deploymentId='string'
)
string
[REQUIRED]
The unique identifier of the application.
string
[REQUIRED]
The unique identifier for the deployment.
dict
Response Syntax
{
'applicationId': 'string',
'applicationVersion': 123,
'creationTime': datetime(2015, 1, 1),
'deploymentId': 'string',
'environmentId': 'string',
'status': 'Deploying'|'Succeeded'|'Failed'|'Updating Deployment',
'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.
{'batchJobExecutions': {'batchJobIdentifier': {'s3BatchJobIdentifier': {'bucket': 'string',
'identifier': {'fileName': 'string',
'scriptName': 'string'},
'keyPrefix': 'string'}}}}
Lists historical, current, and scheduled batch job executions for a specific application.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The unique identifier of the application.
list
The unique identifier of each batch job execution.
(string) --
string
The name of each batch job execution.
integer
The maximum number of batch job executions to return.
string
A pagination token to control the number of batch job executions displayed in the list.
datetime
The time after which the batch job executions started.
datetime
The time before the batch job executions started.
string
The status of the batch job executions.
dict
Response Syntax
{
'batchJobExecutions': [
{
'applicationId': 'string',
'batchJobIdentifier': {
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
's3BatchJobIdentifier': {
'bucket': 'string',
'identifier': {
'fileName': 'string',
'scriptName': 'string'
},
'keyPrefix': 'string'
},
'scriptBatchJobIdentifier': {
'scriptName': 'string'
}
},
'endTime': datetime(2015, 1, 1),
'executionId': 'string',
'jobId': 'string',
'jobName': 'string',
'jobType': 'VSE'|'JES2'|'JES3',
'returnCode': 'string',
'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.
batchJobIdentifier (dict) --
The unique identifier of this batch job.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fileBatchJobIdentifier, s3BatchJobIdentifier, scriptBatchJobIdentifier. 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'}
fileBatchJobIdentifier (dict) --
Specifies a file associated with a specific batch job.
fileName (string) --
The file name for the batch job identifier.
folderPath (string) --
The relative path to the file name for the batch job identifier.
s3BatchJobIdentifier (dict) --
Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
bucket (string) --
The Amazon S3 bucket that contains the batch job definitions.
identifier (dict) --
Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fileName, scriptName. 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'}
fileName (string) --
The name of the file that contains the batch job definition.
scriptName (string) --
The name of the script that contains the batch job definition.
keyPrefix (string) --
The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
scriptBatchJobIdentifier (dict) --
A batch job identifier in which the batch job to run is identified by the script name.
scriptName (string) --
The name of the script containing the batch job definition.
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.
returnCode (string) --
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.
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.
{'dataSetImportTasks': {'status': {'Failed'}, 'statusReason': 'string'}}
Lists the data set imports for the specified application.
See also: AWS API Documentation
Request Syntax
client.list_data_set_import_history(
applicationId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the application.
integer
The maximum number of objects to return.
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.
dict
Response Syntax
{
'dataSetImportTasks': [
{
'status': 'Creating'|'Running'|'Completed'|'Failed',
'statusReason': 'string',
'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.
statusReason (string) --
If dataset import failed, the failure reason will show here.
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.
{'nameFilter': 'string'}
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime 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
client.list_data_sets(
applicationId='string',
maxResults=123,
nameFilter='string',
nextToken='string',
prefix='string'
)
string
[REQUIRED]
The unique identifier of the application for which you want to list the associated data sets.
integer
The maximum number of objects to return.
string
Filter dataset name matching the specified pattern. Can use * and % as wild cards.
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.
string
The prefix of the data set name, which you can use to filter the list of data sets.
dict
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 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.
(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. The only supported value is VSAM.
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.
{'deployments': {'status': {'Updating Deployment'}}}
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
client.list_deployments(
applicationId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The application identifier.
integer
The maximum number of objects to return.
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.
dict
Response Syntax
{
'deployments': [
{
'applicationId': 'string',
'applicationVersion': 123,
'creationTime': datetime(2015, 1, 1),
'deploymentId': 'string',
'environmentId': 'string',
'status': 'Deploying'|'Succeeded'|'Failed'|'Updating Deployment',
'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 runtime 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.
{'batchJobIdentifier': {'s3BatchJobIdentifier': {'bucket': 'string',
'identifier': {'fileName': 'string',
'scriptName': 'string'},
'keyPrefix': 'string'}}}
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
client.start_batch_job(
applicationId='string',
batchJobIdentifier={
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
's3BatchJobIdentifier': {
'bucket': 'string',
'identifier': {
'fileName': 'string',
'scriptName': 'string'
},
'keyPrefix': 'string'
},
'scriptBatchJobIdentifier': {
'scriptName': 'string'
}
},
jobParams={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the application associated with this batch job.
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, s3BatchJobIdentifier, 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.
s3BatchJobIdentifier (dict) --
Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
bucket (string) -- [REQUIRED]
The Amazon S3 bucket that contains the batch job definitions.
identifier (dict) -- [REQUIRED]
Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: fileName, scriptName.
fileName (string) --
The name of the file that contains the batch job definition.
scriptName (string) --
The name of the script that contains the batch job definition.
keyPrefix (string) --
The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
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.
dict
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
(string) --
See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)
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.
dict
Response Syntax
{
'executionId': 'string'
}
Response Structure
(dict) --
executionId (string) --
The unique identifier of this execution of the batch job.
{'forceUpdate': 'boolean'}
Updates the configuration details for a specific runtime environment.
See also: AWS API Documentation
Request Syntax
client.update_environment(
applyDuringMaintenanceWindow=True|False,
desiredCapacity=123,
engineVersion='string',
environmentId='string',
forceUpdate=True|False,
instanceType='string',
preferredMaintenanceWindow='string'
)
boolean
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
The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
string
The version of the runtime engine for the runtime environment.
string
[REQUIRED]
The unique identifier of the runtime environment that you want to update.
boolean
Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.
If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.
This option is not needed if the attribute being updated is preferredMaintenanceWindow .
string
The instance type for the runtime environment to update.
string
Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00 .
If you do not provide a value, a random system-generated value will be assigned.
dict
Response Syntax
{
'environmentId': 'string'
}
Response Structure
(dict) --
environmentId (string) --
The unique identifier of the runtime environment that was updated.