2024/10/22 - AWSMainframeModernization - 5 updated api methods
Changes Add AuthSecretsManagerArn optional parameter to batch job APIs, expand batch parameter limits, and introduce clientToken constraints.
{'authSecretsManagerArn': 'string'}
Cancels the running of a specific batch job execution.
See also: AWS API Documentation
Request Syntax
client.cancel_batch_job_execution(
applicationId='string',
authSecretsManagerArn='string',
executionId='string'
)
string
[REQUIRED]
The unique identifier of the application.
string
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.
string
[REQUIRED]
The unique identifier of the batch job execution.
dict
Response Syntax
{}
Response Structure
(dict) --
{'status': {'UnHealthy'}}
Describes a specific runtime environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
environmentId='string'
)
string
[REQUIRED]
The unique identifier of the runtime environment.
dict
Response Syntax
{
'actualCapacity': 123,
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'engineType': 'microfocus'|'bluage',
'engineVersion': 'string',
'environmentArn': 'string',
'environmentId': 'string',
'highAvailabilityConfig': {
'desiredCapacity': 123
},
'instanceType': 'string',
'kmsKeyId': 'string',
'loadBalancerArn': 'string',
'name': 'string',
'pendingMaintenance': {
'engineVersion': 'string',
'schedule': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
'preferredMaintenanceWindow': 'string',
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed'|'UnHealthy',
'statusReason': 'string',
'storageConfigurations': [
{
'efs': {
'fileSystemId': 'string',
'mountPoint': 'string'
},
'fsx': {
'fileSystemId': 'string',
'mountPoint': 'string'
}
},
],
'subnetIds': [
'string',
],
'tags': {
'string': 'string'
},
'vpcId': 'string'
}
Response Structure
(dict) --
actualCapacity (integer) --
The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
creationTime (datetime) --
The timestamp when the runtime environment was created.
description (string) --
The description of the runtime environment.
engineType (string) --
The target platform for the runtime environment.
engineVersion (string) --
The version of the runtime engine.
environmentArn (string) --
The Amazon Resource Name (ARN) of the runtime environment.
environmentId (string) --
The unique identifier of the runtime environment.
highAvailabilityConfig (dict) --
The desired capacity of the high availability configuration for the runtime environment.
desiredCapacity (integer) --
The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
instanceType (string) --
The type of instance underlying the runtime environment.
kmsKeyId (string) --
The identifier of a customer managed key.
loadBalancerArn (string) --
The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
name (string) --
The name of the runtime environment. Must be unique within the account.
pendingMaintenance (dict) --
Indicates the pending maintenance scheduled on this environment.
engineVersion (string) --
The specific runtime engine that the maintenance schedule applies to.
schedule (dict) --
The maintenance schedule for the runtime engine version.
endTime (datetime) --
The time the scheduled maintenance is to end.
startTime (datetime) --
The time the scheduled maintenance is to start.
preferredMaintenanceWindow (string) --
The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.
publiclyAccessible (boolean) --
Whether applications running in this runtime environment are publicly accessible.
securityGroupIds (list) --
The unique identifiers of the security groups assigned to this runtime environment.
(string) --
status (string) --
The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.
statusReason (string) --
The reason for the reported status.
storageConfigurations (list) --
The storage configurations defined for the runtime environment.
(dict) --
Defines the storage configuration for a runtime environment.
efs (dict) --
Defines the storage configuration for an Amazon EFS file system.
fileSystemId (string) --
The file system identifier.
mountPoint (string) --
The mount point for the file system.
fsx (dict) --
Defines the storage configuration for an Amazon FSx file system.
fileSystemId (string) --
The file system identifier.
mountPoint (string) --
The mount point for the file system.
subnetIds (list) --
The unique identifiers of the subnets assigned to this runtime environment.
(string) --
tags (dict) --
The tags defined for this runtime environment.
(string) --
(string) --
vpcId (string) --
The unique identifier for the VPC used with this runtime environment.
{'authSecretsManagerArn': 'string'}
Lists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
See also: AWS API Documentation
Request Syntax
client.list_batch_job_restart_points(
applicationId='string',
authSecretsManagerArn='string',
executionId='string'
)
string
[REQUIRED]
The unique identifier of the application.
string
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.
string
[REQUIRED]
The unique identifier of the batch job execution.
dict
Response Syntax
{
'batchJobSteps': [
{
'procStepName': 'string',
'procStepNumber': 123,
'stepCondCode': 'string',
'stepName': 'string',
'stepNumber': 123,
'stepRestartable': True|False
},
]
}
Response Structure
(dict) --
batchJobSteps (list) --
Returns all the batch job steps and related information for a batch job that previously ran.
(dict) --
Provides information related to a job step.
procStepName (string) --
The name of a procedure step.
procStepNumber (integer) --
The number of a procedure step.
stepCondCode (string) --
The condition code of a step.
stepName (string) --
The name of a step.
stepNumber (integer) --
The number of a step.
stepRestartable (boolean) --
Specifies if a step can be restarted or not.
{'environments': {'status': {'UnHealthy'}}}
Lists the runtime environments.
See also: AWS API Documentation
Request Syntax
client.list_environments(
engineType='microfocus'|'bluage',
maxResults=123,
names=[
'string',
],
nextToken='string'
)
string
The engine type for the runtime environment.
integer
The maximum number of runtime environments to return.
list
The names of the runtime environments. Must be unique within the account.
(string) --
string
A pagination token to control the number of runtime environments displayed in the list.
dict
Response Syntax
{
'environments': [
{
'creationTime': datetime(2015, 1, 1),
'engineType': 'microfocus'|'bluage',
'engineVersion': 'string',
'environmentArn': 'string',
'environmentId': 'string',
'instanceType': 'string',
'name': 'string',
'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed'|'UnHealthy'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
environments (list) --
Returns a list of summary details for all the runtime environments in your account.
(dict) --
Contains a subset of the possible runtime environment attributes. Used in the environment list.
creationTime (datetime) --
The timestamp when the runtime environment was created.
engineType (string) --
The target platform for the runtime environment.
engineVersion (string) --
The version of the runtime engine.
environmentArn (string) --
The Amazon Resource Name (ARN) of a particular runtime environment.
environmentId (string) --
The unique identifier of a particular runtime environment.
instanceType (string) --
The instance type of the runtime environment.
name (string) --
The name of the runtime environment.
status (string) --
The status of the runtime environment
nextToken (string) --
A pagination token that's returned when the response doesn't contain all the runtime environments.
{'authSecretsManagerArn': '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',
authSecretsManagerArn='string',
batchJobIdentifier={
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
'restartBatchJobIdentifier': {
'executionId': 'string',
'jobStepRestartMarker': {
'fromProcStep': 'string',
'fromStep': 'string',
'toProcStep': 'string',
'toStep': '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.
string
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.
dict
[REQUIRED]
The unique identifier of the batch job.
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.
restartBatchJobIdentifier (dict) --
Specifies the required information for restart, including executionId and JobStepRestartMarker.
executionId (string) -- [REQUIRED]
The executionId from the StartBatchJob response when the job ran for the first time.
jobStepRestartMarker (dict) -- [REQUIRED]
The step/procedure step information for a restart batch job operation.
fromProcStep (string) --
The procedure step name that a batch job was restarted from.
fromStep (string) -- [REQUIRED]
The step name that a batch job was restarted from.
toProcStep (string) --
The procedure step name that a batch job was restarted to.
toStep (string) --
The step name that a batch job was restarted to.
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.
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 ...)
For BluAge Engine: There is no limit in length of keys and values. Additional validation may be applied in code, per engine. Parameter key: the first character must be alphabetic. Can be of up to 32 alphanumeric characters.
(string) --
Parameter value can be of up to 1024 alphanumeric characters.
dict
Response Syntax
{
'executionId': 'string'
}
Response Structure
(dict) --
executionId (string) --
The unique identifier of this execution of the batch job.