AWS SDK for PHP 3.x (original) (raw)
Client: Aws\MainframeModernization\MainframeModernizationClient
Service ID: m2
Version: 2021-04-28
This page describes the parameters and results for the operations of the AWSMainframeModernization (2021-04-28), and shows how to use the Aws\MainframeModernization\MainframeModernizationClientobject to call the described operations. This documentation is specific to the 2021-04-28 API version of the service.
Operation Summary
Each of the following operations can be created from a client using$client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
CancelBatchJobExecution ( array $params = [] )
Cancels the running of a specific batch job execution.
CreateApplication ( array $params = [] )
Creates a new application with given parameters.
CreateDataSetExportTask ( array $params = [] )
Starts a data set export task for a specific application.
CreateDataSetImportTask ( array $params = [] )
Starts a data set import task for a specific application.
CreateDeployment ( array $params = [] )
Creates and starts a deployment to deploy an application into a runtime environment.
CreateEnvironment ( array $params = [] )
Creates a runtime environment for a given runtime engine.
DeleteApplication ( array $params = [] )
Deletes a specific application.
DeleteApplicationFromEnvironment ( array $params = [] )
Deletes a specific application from the specific runtime environment where it was previously deployed.
DeleteEnvironment ( array $params = [] )
Deletes a specific runtime environment.
GetApplication ( array $params = [] )
Describes the details of a specific application.
GetApplicationVersion ( array $params = [] )
Returns details about a specific version of a specific application.
GetBatchJobExecution ( array $params = [] )
Gets the details of a specific batch job execution for a specific application.
GetDataSetDetails ( array $params = [] )
Gets the details of a specific data set.
GetDataSetExportTask ( array $params = [] )
Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
GetDataSetImportTask ( array $params = [] )
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
GetDeployment ( array $params = [] )
Gets details of a specific deployment with a given deployment identifier.
GetEnvironment ( array $params = [] )
Describes a specific runtime environment.
GetSignedBluinsightsUrl ( array $params = [] )
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
ListApplicationVersions ( array $params = [] )
Returns a list of the application versions for a specific application.
ListApplications ( array $params = [] )
Lists the applications associated with a specific Amazon Web Services account.
ListBatchJobDefinitions ( array $params = [] )
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.
ListBatchJobExecutions ( array $params = [] )
Lists historical, current, and scheduled batch job executions for a specific application.
ListBatchJobRestartPoints ( array $params = [] )
Lists all the job steps for a JCL file to restart a batch job.
ListDataSetExportHistory ( array $params = [] )
Lists the data set exports for the specified application.
ListDataSetImportHistory ( array $params = [] )
Lists the data set imports for the specified application.
ListDataSets ( array $params = [] )
Lists the data sets imported for a specific application.
ListDeployments ( array $params = [] )
Returns a list of all deployments of a specific application.
ListEngineVersions ( array $params = [] )
Lists the available engine versions.
ListEnvironments ( array $params = [] )
Lists the runtime environments.
ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
StartApplication ( array $params = [] )
Starts an application that is currently stopped.
StartBatchJob ( array $params = [] )
Starts a batch job and returns the unique identifier of this execution of the batch job.
StopApplication ( array $params = [] )
Stops a running application.
TagResource ( array $params = [] )
Adds one or more tags to the specified resource.
UntagResource ( array $params = [] )
Removes one or more tags from the specified resource.
UpdateApplication ( array $params = [] )
Updates an application and creates a new version.
UpdateEnvironment ( array $params = [] )
Updates the configuration details for a specific runtime environment.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CancelBatchJobExecution
result=result = result=client->cancelBatchJobExecution([/* ... /]); promise=promise = promise=client->cancelBatchJobExecutionAsync([/ ... */]);
Cancels the running of a specific batch job execution.
Parameter Syntax
result=result = result=client->cancelBatchJobExecution([ 'applicationId' => '', // REQUIRED 'authSecretsManagerArn' => '', 'executionId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
authSecretsManagerArn
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.
executionId
Required: Yes
Type: string
The unique identifier of the batch job execution.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
CreateApplication
result=result = result=client->createApplication([/* ... /]); promise=promise = promise=client->createApplicationAsync([/ ... */]);
Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
Parameter Syntax
result=result = result=client->createApplication([ 'clientToken' => '', 'definition' => [ // REQUIRED 'content' => '', 's3Location' => '', ], 'description' => '', 'engineType' => 'microfocus|bluage', // REQUIRED 'kmsKeyId' => '', 'name' => '', // REQUIRED 'roleArn' => '', 'tags' => ['', ...], ]);
Parameter Details
Members
clientToken
A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It's generated by the client to ensure idempotent operations, allowing for safe retries without unintended side effects.
definition
Required: Yes
Type: Definition structure
The application definition for this application. You can specify either inline JSON or an S3 bucket location.
description
The description of the application.
engineType
Required: Yes
Type: string
The type of the target platform for this application.
kmsKeyId
The identifier of a customer managed key.
name
Required: Yes
Type: string
The unique identifier of the application.
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.
tags
Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to apply to the application.
Result Syntax
[ 'applicationArn' => '', 'applicationId' => '', 'applicationVersion' => , ]
Result Details
Members
applicationArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the application.
applicationId
Required: Yes
Type: string
The unique application identifier.
applicationVersion
The version number of the application.
Errors
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
CreateDataSetExportTask
result=result = result=client->createDataSetExportTask([/* ... /]); promise=promise = promise=client->createDataSetExportTaskAsync([/ ... */]);
Starts a data set export task for a specific application.
Parameter Syntax
result=result = result=client->createDataSetExportTask([ 'applicationId' => '', // REQUIRED 'clientToken' => '', 'exportConfig' => [ // REQUIRED 'dataSets' => [ [ 'datasetName' => '', // REQUIRED 'externalLocation' => [ // REQUIRED 's3Location' => '', ], ], // ... ], 's3Location' => '', ], 'kmsKeyId' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application for which you want to export data sets.
clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. 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.
exportConfig
Required: Yes
Type: DataSetExportConfig structure
The data set export task configuration.
kmsKeyId
The identifier of a customer managed key.
Result Syntax
[ 'taskId' => '', ]
Result Details
Members
taskId
Required: Yes
Type: string
The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.
Errors
The specified resource was not found.
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
CreateDataSetImportTask
result=result = result=client->createDataSetImportTask([/* ... /]); promise=promise = promise=client->createDataSetImportTaskAsync([/ ... */]);
Starts a data set import task for a specific application.
Parameter Syntax
result=result = result=client->createDataSetImportTask([ 'applicationId' => '', // REQUIRED 'clientToken' => '', 'importConfig' => [ // REQUIRED 'dataSets' => [ [ 'dataSet' => [ // REQUIRED 'datasetName' => '', // REQUIRED 'datasetOrg' => [ // REQUIRED 'gdg' => [ 'limit' => , 'rollDisposition' => '', ], 'po' => [ 'encoding' => '', 'format' => '', // REQUIRED 'memberFileExtensions' => ['', ...], // REQUIRED ], 'ps' => [ 'encoding' => '', 'format' => '', // REQUIRED ], 'vsam' => [ 'alternateKeys' => [ [ 'allowDuplicates' => true || false, 'length' => , // REQUIRED 'name' => '', 'offset' => , // REQUIRED ], // ... ], 'compressed' => true || false, 'encoding' => '', 'format' => '', // REQUIRED 'primaryKey' => [ 'length' => , // REQUIRED 'name' => '', 'offset' => , // REQUIRED ], ], ], 'recordLength' => [ // REQUIRED 'max' => , // REQUIRED 'min' => , // REQUIRED ], 'relativePath' => '', 'storageType' => '', ], 'externalLocation' => [ // REQUIRED 's3Location' => '', ], ], // ... ], 's3Location' => '', ], ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application for which you want to import data sets.
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.
importConfig
Required: Yes
Type: DataSetImportConfig structure
The data set import task configuration.
Result Syntax
[ 'taskId' => '', ]
Result Details
Members
taskId
Required: Yes
Type: string
The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.
Errors
The specified resource was not found.
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
CreateDeployment
result=result = result=client->createDeployment([/* ... /]); promise=promise = promise=client->createDeploymentAsync([/ ... */]);
Creates and starts a deployment to deploy an application into a runtime environment.
Parameter Syntax
result=result = result=client->createDeployment([ 'applicationId' => '', // REQUIRED 'applicationVersion' => , // REQUIRED 'clientToken' => '', 'environmentId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The application identifier.
applicationVersion
The version of the application to deploy.
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.
environmentId
Required: Yes
Type: string
The identifier of the runtime environment where you want to deploy this application.
Result Syntax
[ 'deploymentId' => '', ]
Result Details
Members
deploymentId
Required: Yes
Type: string
The unique identifier of the deployment.
Errors
The specified resource was not found.
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
CreateEnvironment
result=result = result=client->createEnvironment([/* ... /]); promise=promise = promise=client->createEnvironmentAsync([/ ... */]);
Creates a runtime environment for a given runtime engine.
Parameter Syntax
result=result = result=client->createEnvironment([ 'clientToken' => '', 'description' => '', 'engineType' => 'microfocus|bluage', // REQUIRED 'engineVersion' => '', 'highAvailabilityConfig' => [ 'desiredCapacity' => , // REQUIRED ], 'instanceType' => '', // REQUIRED 'kmsKeyId' => '', 'name' => '', // REQUIRED 'networkType' => 'ipv4|dual', 'preferredMaintenanceWindow' => '', 'publiclyAccessible' => true || false, 'securityGroupIds' => ['', ...], 'storageConfigurations' => [ [ 'efs' => [ 'fileSystemId' => '', // REQUIRED 'mountPoint' => '', // REQUIRED ], 'fsx' => [ 'fileSystemId' => '', // REQUIRED 'mountPoint' => '', // REQUIRED ], ], // ... ], 'subnetIds' => ['', ...], 'tags' => ['', ...], ]);
Parameter Details
Members
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.
description
The description of the runtime environment.
engineType
Required: Yes
Type: string
The engine type for the runtime environment.
engineVersion
The version of the engine type for the runtime environment.
highAvailabilityConfig
Type: HighAvailabilityConfig structure
The details of a high availability configuration for this runtime environment.
instanceType
Required: Yes
Type: string
The type of instance for the runtime environment.
kmsKeyId
The identifier of a customer managed key.
name
Required: Yes
Type: string
The name of the runtime environment. Must be unique within the account.
networkType
The network type required for the runtime environment.
preferredMaintenanceWindow
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.
publiclyAccessible
Specifies whether the runtime environment is publicly accessible.
securityGroupIds
The list of security groups for the VPC associated with this runtime environment.
storageConfigurations
Type: Array of StorageConfiguration structures
Optional. The storage configurations for this runtime environment.
subnetIds
The list of subnets associated with the VPC for this runtime environment.
tags
Type: Associative array of custom strings keys (TagKey) to strings
The tags for the runtime environment.
Result Syntax
[ 'environmentId' => '', ]
Result Details
Members
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment.
Errors
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
DeleteApplication
result=result = result=client->deleteApplication([/* ... /]); promise=promise = promise=client->deleteApplicationAsync([/ ... */]);
Deletes a specific application. You cannot delete a running application.
Parameter Syntax
result=result = result=client->deleteApplication([ 'applicationId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application you want to delete.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
DeleteApplicationFromEnvironment
result=result = result=client->deleteApplicationFromEnvironment([/* ... /]); promise=promise = promise=client->deleteApplicationFromEnvironmentAsync([/ ... */]);
Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
Parameter Syntax
result=result = result=client->deleteApplicationFromEnvironment([ 'applicationId' => '', // REQUIRED 'environmentId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application you want to delete.
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment where the application was previously deployed.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
DeleteEnvironment
result=result = result=client->deleteEnvironment([/* ... /]); promise=promise = promise=client->deleteEnvironmentAsync([/ ... */]);
Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
Parameter Syntax
result=result = result=client->deleteEnvironment([ 'environmentId' => '', // REQUIRED ]);
Parameter Details
Members
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment you want to delete.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetApplication
result=result = result=client->getApplication([/* ... /]); promise=promise = promise=client->getApplicationAsync([/ ... */]);
Describes the details of a specific application.
Parameter Syntax
result=result = result=client->getApplication([ 'applicationId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The identifier of the application.
Result Syntax
[ 'applicationArn' => '', 'applicationId' => '', 'creationTime' => , 'deployedVersion' => [ 'applicationVersion' => , 'status' => 'Deploying|Succeeded|Failed|Updating Deployment', 'statusReason' => '', ], 'description' => '', 'engineType' => 'microfocus|bluage', 'environmentId' => '', 'kmsKeyId' => '', 'lastStartTime' => , 'latestVersion' => [ 'applicationVersion' => , 'creationTime' => , 'status' => 'Creating|Available|Failed', 'statusReason' => '', ], 'listenerArns' => ['', ...], 'listenerPorts' => [, ...], 'loadBalancerDnsName' => '', 'logGroups' => [ [ 'logGroupName' => '', 'logType' => '', ], // ... ], 'name' => '', 'roleArn' => '', 'status' => 'Creating|Created|Available|Ready|Starting|Running|Stopping|Stopped|Failed|Deleting|Deleting From Environment', 'statusReason' => '', 'tags' => ['', ...], 'targetGroupArns' => ['', ...], ]
Result Details
Members
applicationArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the application.
applicationId
Required: Yes
Type: string
The identifier of the application.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this application was created.
deployedVersion
Type: DeployedVersionSummary structure
The version of the application that is deployed.
description
The description of the application.
engineType
Required: Yes
Type: string
The type of the target platform for the application.
environmentId
The identifier of the runtime environment where you want to deploy the application.
kmsKeyId
The identifier of a customer managed key.
lastStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when you last started the application. Null until the application runs for the first time.
latestVersion
Required: Yes
Type: ApplicationVersionSummary structure
The latest version of the application.
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.
listenerPorts
The port associated with the network load balancer listener created in your Amazon Web Services account.
loadBalancerDnsName
The public DNS name of the load balancer created in your Amazon Web Services account.
logGroups
Type: Array of LogGroupSummary structures
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.
name
Required: Yes
Type: string
The unique identifier of the application.
roleArn
The Amazon Resource Name (ARN) of the role associated with the application.
status
Required: Yes
Type: string
The status of the application.
statusReason
The reason for the reported status.
tags
Type: Associative array of custom strings keys (TagKey) to strings
A list of tags associated with the application.
targetGroupArns
Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetApplicationVersion
result=result = result=client->getApplicationVersion([/* ... /]); promise=promise = promise=client->getApplicationVersionAsync([/ ... */]);
Returns details about a specific version of a specific application.
Parameter Syntax
result=result = result=client->getApplicationVersion([ 'applicationId' => '', // REQUIRED 'applicationVersion' => , // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
applicationVersion
The specific version of the application.
Result Syntax
[ 'applicationVersion' => , 'creationTime' => , 'definitionContent' => '', 'description' => '', 'name' => '', 'status' => 'Creating|Available|Failed', 'statusReason' => '', ]
Result Details
Members
applicationVersion
The specific version of the application.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the application version was created.
definitionContent
Required: Yes
Type: string
The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application.
description
The application description.
name
Required: Yes
Type: string
The name of the application version.
status
Required: Yes
Type: string
The status of the application version.
statusReason
The reason for the reported status.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetBatchJobExecution
result=result = result=client->getBatchJobExecution([/* ... /]); promise=promise = promise=client->getBatchJobExecutionAsync([/ ... */]);
Gets the details of a specific batch job execution for a specific application.
Parameter Syntax
result=result = result=client->getBatchJobExecution([ 'applicationId' => '', // REQUIRED 'executionId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The identifier of the application.
executionId
Required: Yes
Type: string
The unique identifier of the batch job execution.
Result Syntax
[ 'applicationId' => '', 'batchJobIdentifier' => [ 'fileBatchJobIdentifier' => [ 'fileName' => '', 'folderPath' => '', ], 'restartBatchJobIdentifier' => [ 'executionId' => '', 'jobStepRestartMarker' => [ 'fromProcStep' => '', 'fromStep' => '', 'skip' => true || false, 'stepCheckpoint' => , 'toProcStep' => '', 'toStep' => '', ], ], 's3BatchJobIdentifier' => [ 'bucket' => '', 'identifier' => [ 'fileName' => '', 'scriptName' => '', ], 'keyPrefix' => '', ], 'scriptBatchJobIdentifier' => [ 'scriptName' => '', ], ], 'endTime' => , 'executionId' => '', 'jobId' => '', 'jobName' => '', 'jobStepRestartMarker' => [ 'fromProcStep' => '', 'fromStep' => '', 'skip' => true || false, 'stepCheckpoint' => , 'toProcStep' => '', 'toStep' => '', ], 'jobType' => 'VSE|JES2|JES3', 'jobUser' => '', 'returnCode' => '', 'startTime' => , 'status' => 'Submitting|Holding|Dispatching|Running|Cancelling|Cancelled|Succeeded|Failed|Purged|Succeeded With Warning', 'statusReason' => '', ]
Result Details
Members
applicationId
Required: Yes
Type: string
The identifier of the application.
batchJobIdentifier
Type: BatchJobIdentifier structure
The unique identifier of this batch job.
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the batch job execution ended.
executionId
Required: Yes
Type: string
The unique identifier for this batch job execution.
jobId
The unique identifier for this batch job.
jobName
The name of this batch job.
jobStepRestartMarker
Type: JobStepRestartMarker structure
The step/procedure step information for the restart batch job operation.
jobType
The type of job.
jobUser
The user for the job.
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.
startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the batch job execution started.
status
Required: Yes
Type: string
The status of the batch job execution.
statusReason
The reason for the reported status.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetDataSetDetails
result=result = result=client->getDataSetDetails([/* ... /]); promise=promise = promise=client->getDataSetDetailsAsync([/ ... */]);
Gets the details of a specific data set.
Parameter Syntax
result=result = result=client->getDataSetDetails([ 'applicationId' => '', // REQUIRED 'dataSetName' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application that this data set is associated with.
dataSetName
Required: Yes
Type: string
The name of the data set.
Result Syntax
[ 'blocksize' => , 'creationTime' => , 'dataSetName' => '', 'dataSetOrg' => [ 'gdg' => [ 'limit' => , 'rollDisposition' => '', ], 'po' => [ 'encoding' => '', 'format' => '', ], 'ps' => [ 'encoding' => '', 'format' => '', ], 'vsam' => [ 'alternateKeys' => [ [ 'allowDuplicates' => true || false, 'length' => , 'name' => '', 'offset' => , ], // ... ], 'cacheAtStartup' => true || false, 'compressed' => true || false, 'encoding' => '', 'primaryKey' => [ 'length' => , 'name' => '', 'offset' => , ], 'recordFormat' => '', ], ], 'fileSize' => , 'lastReferencedTime' => , 'lastUpdatedTime' => , 'location' => '', 'recordLength' => , ]
Result Details
Members
blocksize
The size of the block on disk.
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the data set was created.
dataSetName
Required: Yes
Type: string
The name of the data set.
dataSetOrg
Type: DatasetDetailOrgAttributes structure
The type of data set. The only supported value is VSAM.
fileSize
File size of the dataset.
lastReferencedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data set was referenced.
lastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data set was updated.
location
The location where the data set is stored.
recordLength
The length of records in the data set.
Errors
The specified resource was not found.
Failed to connect to server, or didn’t receive response within expected time period.
Server cannot process the request at the moment.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetDataSetExportTask
result=result = result=client->getDataSetExportTask([/* ... /]); promise=promise = promise=client->getDataSetExportTaskAsync([/ ... */]);
Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
Parameter Syntax
result=result = result=client->getDataSetExportTask([ 'applicationId' => '', // REQUIRED 'taskId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The application identifier.
taskId
Required: Yes
Type: string
Result Syntax
[ 'kmsKeyArn' => '', 'status' => 'Creating|Running|Completed|Failed', 'statusReason' => '', 'summary' => [ 'failed' => , 'inProgress' => , 'pending' => , 'succeeded' => , 'total' => , ], 'taskId' => '', ]
Result Details
Members
kmsKeyArn
The identifier of a customer managed key used for exported data set encryption.
status
Required: Yes
Type: string
The status of the task.
statusReason
If dataset export failed, the failure reason will show here.
summary
Type: DataSetExportSummary structure
A summary of the status of the task.
taskId
Required: Yes
Type: string
The task identifier.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetDataSetImportTask
result=result = result=client->getDataSetImportTask([/* ... /]); promise=promise = promise=client->getDataSetImportTaskAsync([/ ... */]);
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
Parameter Syntax
result=result = result=client->getDataSetImportTask([ 'applicationId' => '', // REQUIRED 'taskId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The application identifier.
taskId
Required: Yes
Type: string
Result Syntax
[ 'status' => 'Creating|Running|Completed|Failed', 'summary' => [ 'failed' => , 'inProgress' => , 'pending' => , 'succeeded' => , 'total' => , ], 'taskId' => '', ]
Result Details
Members
status
Required: Yes
Type: string
The status of the task.
summary
Type: DataSetImportSummary structure
A summary of the status of the task.
taskId
Required: Yes
Type: string
The task identifier.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetDeployment
result=result = result=client->getDeployment([/* ... /]); promise=promise = promise=client->getDeploymentAsync([/ ... */]);
Gets details of a specific deployment with a given deployment identifier.
Parameter Syntax
result=result = result=client->getDeployment([ 'applicationId' => '', // REQUIRED 'deploymentId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
deploymentId
Required: Yes
Type: string
The unique identifier for the deployment.
Result Syntax
[ 'applicationId' => '', 'applicationVersion' => , 'creationTime' => , 'deploymentId' => '', 'environmentId' => '', 'status' => 'Deploying|Succeeded|Failed|Updating Deployment', 'statusReason' => '', ]
Result Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
applicationVersion
The application version.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the deployment was created.
deploymentId
Required: Yes
Type: string
The unique identifier of the deployment.
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment.
status
Required: Yes
Type: string
The status of the deployment.
statusReason
The reason for the reported status.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetEnvironment
result=result = result=client->getEnvironment([/* ... /]); promise=promise = promise=client->getEnvironmentAsync([/ ... */]);
Describes a specific runtime environment.
Parameter Syntax
result=result = result=client->getEnvironment([ 'environmentId' => '', // REQUIRED ]);
Parameter Details
Members
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment.
Result Syntax
[ 'actualCapacity' => , 'creationTime' => , 'description' => '', 'engineType' => 'microfocus|bluage', 'engineVersion' => '', 'environmentArn' => '', 'environmentId' => '', 'highAvailabilityConfig' => [ 'desiredCapacity' => , ], 'instanceType' => '', 'kmsKeyId' => '', 'loadBalancerArn' => '', 'name' => '', 'networkType' => 'ipv4|dual', 'pendingMaintenance' => [ 'engineVersion' => '', 'schedule' => [ 'endTime' => , 'startTime' => , ], ], 'preferredMaintenanceWindow' => '', 'publiclyAccessible' => true || false, 'securityGroupIds' => ['', ...], 'status' => 'Creating|Available|Updating|Deleting|Failed|UnHealthy', 'statusReason' => '', 'storageConfigurations' => [ [ 'efs' => [ 'fileSystemId' => '', 'mountPoint' => '', ], 'fsx' => [ 'fileSystemId' => '', 'mountPoint' => '', ], ], // ... ], 'subnetIds' => ['', ...], 'tags' => ['', ...], 'vpcId' => '', ]
Result Details
Members
actualCapacity
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
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the runtime environment was created.
description
The description of the runtime environment.
engineType
Required: Yes
Type: string
The target platform for the runtime environment.
engineVersion
Required: Yes
Type: string
The version of the runtime engine.
environmentArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the runtime environment.
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment.
highAvailabilityConfig
Type: HighAvailabilityConfig structure
The desired capacity of the high availability configuration for the runtime environment.
instanceType
Required: Yes
Type: string
The type of instance underlying the runtime environment.
kmsKeyId
The identifier of a customer managed key.
loadBalancerArn
The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
name
Required: Yes
Type: string
The name of the runtime environment. Must be unique within the account.
networkType
The network type supported by the runtime environment.
pendingMaintenance
Type: PendingMaintenance structure
Indicates the pending maintenance scheduled on this environment.
preferredMaintenanceWindow
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
Whether applications running in this runtime environment are publicly accessible.
securityGroupIds
Required: Yes
Type: Array of strings
The unique identifiers of the security groups assigned to this runtime environment.
status
Required: Yes
Type: 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
The reason for the reported status.
storageConfigurations
Type: Array of StorageConfiguration structures
The storage configurations defined for the runtime environment.
subnetIds
Required: Yes
Type: Array of strings
The unique identifiers of the subnets assigned to this runtime environment.
tags
Type: Associative array of custom strings keys (TagKey) to strings
The tags defined for this runtime environment.
vpcId
Required: Yes
Type: string
The unique identifier for the VPC used with this runtime environment.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
GetSignedBluinsightsUrl
result=result = result=client->getSignedBluinsightsUrl([/* ... /]); promise=promise = promise=client->getSignedBluinsightsUrlAsync([/ ... */]);
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
Parameter Syntax
result=result = result=client->getSignedBluinsightsUrl([ ]);
Parameter Details
Members
Result Syntax
[ 'signedBiUrl' => '', ]
Result Details
Members
signedBiUrl
Required: Yes
Type: string
Single sign-on AWS Blu Insights URL.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
An unexpected error occurred during the processing of the request.
ListApplicationVersions
result=result = result=client->listApplicationVersions([/* ... /]); promise=promise = promise=client->listApplicationVersionsAsync([/ ... */]);
Returns a list of the application versions for a specific application.
Parameter Syntax
result=result = result=client->listApplicationVersions([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
maxResults
The maximum number of application versions to return.
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.
Result Syntax
[ 'applicationVersions' => [ [ 'applicationVersion' => , 'creationTime' => , 'status' => 'Creating|Available|Failed', 'statusReason' => '', ], // ... ], 'nextToken' => '', ]
Result Details
Members
applicationVersions
Required: Yes
Type: Array of ApplicationVersionSummary structures
The list of application versions.
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.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListApplications
result=result = result=client->listApplications([/* ... /]); promise=promise = promise=client->listApplicationsAsync([/ ... */]);
Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
Parameter Syntax
result=result = result=client->listApplications([ 'environmentId' => '', 'maxResults' => , 'names' => ['', ...], 'nextToken' => '', ]);
Parameter Details
Members
environmentId
The unique identifier of the runtime environment where the applications are deployed.
maxResults
The maximum number of applications to return.
names
The names of the applications.
nextToken
A pagination token to control the number of applications displayed in the list.
Result Syntax
[ 'applications' => [ [ 'applicationArn' => '', 'applicationId' => '', 'applicationVersion' => , 'creationTime' => , 'deploymentStatus' => 'Deploying|Deployed', 'description' => '', 'engineType' => 'microfocus|bluage', 'environmentId' => '', 'lastStartTime' => , 'name' => '', 'roleArn' => '', 'status' => 'Creating|Created|Available|Ready|Starting|Running|Stopping|Stopped|Failed|Deleting|Deleting From Environment', 'versionStatus' => 'Creating|Available|Failed', ], // ... ], 'nextToken' => '', ]
Result Details
Members
applications
Required: Yes
Type: Array of ApplicationSummary structures
Returns a list of summary details for all the applications in a runtime environment.
nextToken
A pagination token that's returned when the response doesn't contain all applications.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListBatchJobDefinitions
result=result = result=client->listBatchJobDefinitions([/* ... /]); promise=promise = promise=client->listBatchJobDefinitionsAsync([/ ... */]);
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
Parameter Syntax
result=result = result=client->listBatchJobDefinitions([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', 'prefix' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The identifier of the application.
maxResults
The maximum number of batch job definitions to return.
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.
prefix
If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
Result Syntax
[ 'batchJobDefinitions' => [ [ 'fileBatchJobDefinition' => [ 'fileName' => '', 'folderPath' => '', ], 'scriptBatchJobDefinition' => [ 'scriptName' => '', ], ], // ... ], 'nextToken' => '', ]
Result Details
Members
batchJobDefinitions
Required: Yes
Type: Array of BatchJobDefinition structures
The list of batch job definitions.
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.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListBatchJobExecutions
result=result = result=client->listBatchJobExecutions([/* ... /]); promise=promise = promise=client->listBatchJobExecutionsAsync([/ ... */]);
Lists historical, current, and scheduled batch job executions for a specific application.
Parameter Syntax
result=result = result=client->listBatchJobExecutions([ 'applicationId' => '', // REQUIRED 'executionIds' => ['', ...], 'jobName' => '', 'maxResults' => , 'nextToken' => '', 'startedAfter' => <integer || string || DateTime>, 'startedBefore' => <integer || string || DateTime>, 'status' => 'Submitting|Holding|Dispatching|Running|Cancelling|Cancelled|Succeeded|Failed|Purged|Succeeded With Warning', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
executionIds
The unique identifier of each batch job execution.
jobName
The name of each batch job execution.
maxResults
The maximum number of batch job executions to return.
nextToken
A pagination token to control the number of batch job executions displayed in the list.
startedAfter
Type: timestamp (string|DateTime or anything parsable by strtotime)
The time after which the batch job executions started.
startedBefore
Type: timestamp (string|DateTime or anything parsable by strtotime)
The time before the batch job executions started.
status
The status of the batch job executions.
Result Syntax
[ 'batchJobExecutions' => [ [ 'applicationId' => '', 'batchJobIdentifier' => [ 'fileBatchJobIdentifier' => [ 'fileName' => '', 'folderPath' => '', ], 'restartBatchJobIdentifier' => [ 'executionId' => '', 'jobStepRestartMarker' => [ 'fromProcStep' => '', 'fromStep' => '', 'skip' => true || false, 'stepCheckpoint' => , 'toProcStep' => '', 'toStep' => '', ], ], 's3BatchJobIdentifier' => [ 'bucket' => '', 'identifier' => [ 'fileName' => '', 'scriptName' => '', ], 'keyPrefix' => '', ], 'scriptBatchJobIdentifier' => [ 'scriptName' => '', ], ], 'endTime' => , 'executionId' => '', 'jobId' => '', 'jobName' => '', 'jobType' => 'VSE|JES2|JES3', 'returnCode' => '', 'startTime' => , 'status' => 'Submitting|Holding|Dispatching|Running|Cancelling|Cancelled|Succeeded|Failed|Purged|Succeeded With Warning', ], // ... ], 'nextToken' => '', ]
Result Details
Members
batchJobExecutions
Required: Yes
Type: Array of BatchJobExecutionSummary structures
Returns a list of batch job executions for an application.
nextToken
A pagination token that's returned when the response doesn't contain all batch job executions.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListBatchJobRestartPoints
result=result = result=client->listBatchJobRestartPoints([/* ... /]); promise=promise = promise=client->listBatchJobRestartPointsAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->listBatchJobRestartPoints([ 'applicationId' => '', // REQUIRED 'authSecretsManagerArn' => '', 'executionId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
authSecretsManagerArn
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.
executionId
Required: Yes
Type: string
The unique identifier of the batch job execution.
Result Syntax
[ 'batchJobSteps' => [ [ 'procStepName' => '', 'procStepNumber' => , 'stepCheckpoint' => , 'stepCheckpointStatus' => '', 'stepCheckpointTime' => , 'stepCondCode' => '', 'stepName' => '', 'stepNumber' => , 'stepRestartable' => true || false, ], // ... ], ]
Result Details
Members
batchJobSteps
Type: Array of JobStep structures
Returns all the batch job steps and related information for a batch job that previously ran.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListDataSetExportHistory
result=result = result=client->listDataSetExportHistory([/* ... /]); promise=promise = promise=client->listDataSetExportHistoryAsync([/ ... */]);
Lists the data set exports for the specified application.
Parameter Syntax
result=result = result=client->listDataSetExportHistory([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
maxResults
The maximum number of objects to return.
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.
Result Syntax
[ 'dataSetExportTasks' => [ [ 'status' => 'Creating|Running|Completed|Failed', 'statusReason' => '', 'summary' => [ 'failed' => , 'inProgress' => , 'pending' => , 'succeeded' => , 'total' => , ], 'taskId' => '', ], // ... ], 'nextToken' => '', ]
Result Details
Members
dataSetExportTasks
Required: Yes
Type: Array of DataSetExportTask structures
The data set export tasks.
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.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListDataSetImportHistory
result=result = result=client->listDataSetImportHistory([/* ... /]); promise=promise = promise=client->listDataSetImportHistoryAsync([/ ... */]);
Lists the data set imports for the specified application.
Parameter Syntax
result=result = result=client->listDataSetImportHistory([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
maxResults
The maximum number of objects to return.
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.
Result Syntax
[ 'dataSetImportTasks' => [ [ 'status' => 'Creating|Running|Completed|Failed', 'statusReason' => '', 'summary' => [ 'failed' => , 'inProgress' => , 'pending' => , 'succeeded' => , 'total' => , ], 'taskId' => '', ], // ... ], 'nextToken' => '', ]
Result Details
Members
dataSetImportTasks
Required: Yes
Type: Array of DataSetImportTask structures
The data set import tasks.
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.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListDataSets
result=result = result=client->listDataSets([/* ... /]); promise=promise = promise=client->listDataSetsAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->listDataSets([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nameFilter' => '', 'nextToken' => '', 'prefix' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application for which you want to list the associated data sets.
maxResults
The maximum number of objects to return.
nameFilter
Filter dataset name matching the specified pattern. Can use * and % as wild cards.
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.
prefix
The prefix of the data set name, which you can use to filter the list of data sets.
Result Syntax
[ 'dataSets' => [ [ 'creationTime' => , 'dataSetName' => '', 'dataSetOrg' => '', 'format' => '', 'lastReferencedTime' => , 'lastUpdatedTime' => , ], // ... ], 'nextToken' => '', ]
Result Details
Members
dataSets
Required: Yes
Type: Array of DataSetSummary structures
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.
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.
Errors
The specified resource was not found.
Failed to connect to server, or didn’t receive response within expected time period.
Server cannot process the request at the moment.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListDeployments
result=result = result=client->listDeployments([/* ... /]); promise=promise = promise=client->listDeploymentsAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->listDeployments([ 'applicationId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The application identifier.
maxResults
The maximum number of objects to return.
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.
Result Syntax
[ 'deployments' => [ [ 'applicationId' => '', 'applicationVersion' => , 'creationTime' => , 'deploymentId' => '', 'environmentId' => '', 'status' => 'Deploying|Succeeded|Failed|Updating Deployment', 'statusReason' => '', ], // ... ], 'nextToken' => '', ]
Result Details
Members
deployments
Required: Yes
Type: Array of DeploymentSummary structures
The list of deployments that is returned.
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.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListEngineVersions
result=result = result=client->listEngineVersions([/* ... /]); promise=promise = promise=client->listEngineVersionsAsync([/ ... */]);
Lists the available engine versions.
Parameter Syntax
result=result = result=client->listEngineVersions([ 'engineType' => 'microfocus|bluage', 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
engineType
The type of target platform.
maxResults
The maximum number of objects to return.
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.
Result Syntax
[ 'engineVersions' => [ [ 'engineType' => '', 'engineVersion' => '', ], // ... ], 'nextToken' => '', ]
Result Details
Members
engineVersions
Required: Yes
Type: Array of EngineVersionsSummary structures
Returns the engine versions.
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.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListEnvironments
result=result = result=client->listEnvironments([/* ... /]); promise=promise = promise=client->listEnvironmentsAsync([/ ... */]);
Lists the runtime environments.
Parameter Syntax
result=result = result=client->listEnvironments([ 'engineType' => 'microfocus|bluage', 'maxResults' => , 'names' => ['', ...], 'nextToken' => '', ]);
Parameter Details
Members
engineType
The engine type for the runtime environment.
maxResults
The maximum number of runtime environments to return.
names
The names of the runtime environments. Must be unique within the account.
nextToken
A pagination token to control the number of runtime environments displayed in the list.
Result Syntax
[ 'environments' => [ [ 'creationTime' => , 'engineType' => 'microfocus|bluage', 'engineVersion' => '', 'environmentArn' => '', 'environmentId' => '', 'instanceType' => '', 'name' => '', 'networkType' => 'ipv4|dual', 'status' => 'Creating|Available|Updating|Deleting|Failed|UnHealthy', ], // ... ], 'nextToken' => '', ]
Result Details
Members
environments
Required: Yes
Type: Array of EnvironmentSummary structures
Returns a list of summary details for all the runtime environments in your account.
nextToken
A pagination token that's returned when the response doesn't contain all the runtime environments.
Errors
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
ListTagsForResource
result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);
Lists the tags for the specified resource.
Parameter Syntax
result=result = result=client->listTagsForResource([ 'resourceArn' => '', // REQUIRED ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the resource.
Result Syntax
[ 'tags' => ['', ...], ]
Result Details
Members
tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings
The tags for the resource.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
StartApplication
result=result = result=client->startApplication([/* ... /]); promise=promise = promise=client->startApplicationAsync([/ ... */]);
Starts an application that is currently stopped.
Parameter Syntax
result=result = result=client->startApplication([ 'applicationId' => '', // REQUIRED ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application you want to start.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
StartBatchJob
result=result = result=client->startBatchJob([/* ... /]); promise=promise = promise=client->startBatchJobAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->startBatchJob([ 'applicationId' => '', // REQUIRED 'authSecretsManagerArn' => '', 'batchJobIdentifier' => [ // REQUIRED 'fileBatchJobIdentifier' => [ 'fileName' => '', // REQUIRED 'folderPath' => '', ], 'restartBatchJobIdentifier' => [ 'executionId' => '', // REQUIRED 'jobStepRestartMarker' => [ // REQUIRED 'fromProcStep' => '', 'fromStep' => '', // REQUIRED 'skip' => true || false, 'stepCheckpoint' => , 'toProcStep' => '', 'toStep' => '', ], ], 's3BatchJobIdentifier' => [ 'bucket' => '', // REQUIRED 'identifier' => [ // REQUIRED 'fileName' => '', 'scriptName' => '', ], 'keyPrefix' => '', ], 'scriptBatchJobIdentifier' => [ 'scriptName' => '', // REQUIRED ], ], 'jobParams' => ['', ...], ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application associated with this batch job.
authSecretsManagerArn
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.
batchJobIdentifier
Required: Yes
Type: BatchJobIdentifier structure
The unique identifier of the batch job.
jobParams
Type: Associative array of custom strings keys (BatchParamKey) to strings
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
Result Syntax
[ 'executionId' => '', ]
Result Details
Members
executionId
Required: Yes
Type: string
The unique identifier of this execution of the batch job.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
StopApplication
result=result = result=client->stopApplication([/* ... /]); promise=promise = promise=client->stopApplicationAsync([/ ... */]);
Stops a running application.
Parameter Syntax
result=result = result=client->stopApplication([ 'applicationId' => '', // REQUIRED 'forceStop' => true || false, ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application you want to stop.
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.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
TagResource
result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);
Adds one or more tags to the specified resource.
Parameter Syntax
result=result = result=client->tagResource([ 'resourceArn' => '', // REQUIRED 'tags' => ['', ...], // REQUIRED ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the resource.
tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings
The tags to add to the resource.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
UntagResource
result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);
Removes one or more tags from the specified resource.
Parameter Syntax
result=result = result=client->untagResource([ 'resourceArn' => '', // REQUIRED 'tagKeys' => ['', ...], // REQUIRED ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the resource.
tagKeys
Required: Yes
Type: Array of strings
The keys of the tags to remove.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
UpdateApplication
result=result = result=client->updateApplication([/* ... /]); promise=promise = promise=client->updateApplicationAsync([/ ... */]);
Updates an application and creates a new version.
Parameter Syntax
result=result = result=client->updateApplication([ 'applicationId' => '', // REQUIRED 'currentApplicationVersion' => , // REQUIRED 'definition' => [ 'content' => '', 's3Location' => '', ], 'description' => '', ]);
Parameter Details
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application you want to update.
currentApplicationVersion
The current version of the application to update.
definition
Type: Definition structure
The application definition for this application. You can specify either inline JSON or an S3 bucket location.
description
The description of the application to update.
Result Syntax
[ 'applicationVersion' => , ]
Result Details
Members
applicationVersion
The new version of the application.
Errors
The specified resource was not found.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
UpdateEnvironment
result=result = result=client->updateEnvironment([/* ... /]); promise=promise = promise=client->updateEnvironmentAsync([/ ... */]);
Updates the configuration details for a specific runtime environment.
Parameter Syntax
result=result = result=client->updateEnvironment([ 'applyDuringMaintenanceWindow' => true || false, 'desiredCapacity' => , 'engineVersion' => '', 'environmentId' => '', // REQUIRED 'forceUpdate' => true || false, 'instanceType' => '', 'preferredMaintenanceWindow' => '', ]);
Parameter Details
Members
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.
desiredCapacity
The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
engineVersion
The version of the runtime engine for the runtime environment.
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment that you want to update.
forceUpdate
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.
instanceType
The instance type for the runtime environment to update.
preferredMaintenanceWindow
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.
Result Syntax
[ 'environmentId' => '', ]
Result Details
Members
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment that was updated.
Errors
The specified resource was not found.
ServiceQuotaExceededException:
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
The number of requests made exceeds the limit.
The account or role doesn't have the right permissions to make the request.
The parameters provided in the request conflict with existing resources.
One or more parameters provided in the request is not valid.
An unexpected error occurred during the processing of the request.
Shapes
AccessDeniedException
Description
The account or role doesn't have the right permissions to make the request.
Members
message
Required: Yes
Type: string
AlternateKey
Description
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.
Members
allowDuplicates
Indicates whether the alternate key values are supposed to be unique for the given data set.
length
A strictly positive integer value representing the length of the alternate key.
name
The name of the alternate key.
offset
A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
ApplicationSummary
Description
A subset of the possible application attributes. Used in the application list.
Members
applicationArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the application.
applicationId
Required: Yes
Type: string
The unique identifier of the application.
applicationVersion
The version of the application.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the application was created.
deploymentStatus
Indicates either an ongoing deployment or if the application has ever deployed successfully.
description
The description of the application.
engineType
Required: Yes
Type: string
The type of the target platform for this application.
environmentId
The unique identifier of the runtime environment that hosts this application.
lastStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when you last started the application. Null until the application runs for the first time.
name
Required: Yes
Type: string
The name of the application.
roleArn
The Amazon Resource Name (ARN) of the role associated with the application.
status
Required: Yes
Type: string
The status of the application.
versionStatus
Indicates the status of the latest version of the application.
ApplicationVersionSummary
Description
Defines an application version summary.
Members
applicationVersion
The application version.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the application version was created.
status
Required: Yes
Type: string
The status of the application.
statusReason
The reason for the reported status.
BatchJobDefinition
Description
Defines the details of a batch job.
Members
fileBatchJobDefinition
Type: FileBatchJobDefinition structure
Specifies a file containing a batch job definition.
scriptBatchJobDefinition
Type: ScriptBatchJobDefinition structure
A script containing a batch job definition.
BatchJobExecutionSummary
Description
A subset of the possible batch job attributes. Used in the batch job list.
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application that hosts this batch job.
batchJobIdentifier
Type: BatchJobIdentifier structure
The unique identifier of this batch job.
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this batch job execution ended.
executionId
Required: Yes
Type: string
The unique identifier of this execution of the batch job.
jobId
The unique identifier of a particular batch job.
jobName
The name of a particular batch job.
jobType
The type of a particular batch job execution.
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.
startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when a particular batch job execution started.
status
Required: Yes
Type: string
The status of a particular batch job execution.
BatchJobIdentifier
Description
Identifies a specific batch job.
Members
fileBatchJobIdentifier
Type: FileBatchJobIdentifier structure
Specifies a file associated with a specific batch job.
restartBatchJobIdentifier
Type: RestartBatchJobIdentifier structure
Specifies the required information for restart, including executionId and JobStepRestartMarker.
s3BatchJobIdentifier
Type: S3BatchJobIdentifier structure
Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
scriptBatchJobIdentifier
Type: ScriptBatchJobIdentifier structure
A batch job identifier in which the batch job to run is identified by the script name.
ConflictException
Description
The parameters provided in the request conflict with existing resources.
Members
message
Required: Yes
Type: string
resourceId
The ID of the conflicting resource.
resourceType
The type of the conflicting resource.
DataSet
Description
Defines a data set.
Members
datasetName
Required: Yes
Type: string
The logical identifier for a specific data set (in mainframe format).
datasetOrg
Required: Yes
Type: DatasetOrgAttributes structure
The type of dataset. The only supported value is VSAM.
recordLength
Required: Yes
Type: RecordLength structure
The length of a record.
relativePath
The relative location of the data set in the database or file system.
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.
DataSetExportConfig
Description
Identifies one or more data sets you want to import with the CreateDataSetExportTask operation.
Members
dataSets
Type: Array of DataSetExportItem structures
The data sets.
s3Location
The Amazon S3 location of the data sets.
DataSetExportItem
Description
Identifies a specific data set to export from an external location.
Members
datasetName
Required: Yes
Type: string
The data set.
externalLocation
Required: Yes
Type: ExternalLocation structure
The location of the data set.
DataSetExportSummary
Description
Represents a summary of data set exports.
Members
failed
The number of data set exports that have failed.
inProgress
The number of data set exports that are in progress.
pending
The number of data set exports that are pending.
succeeded
The number of data set exports that have succeeded.
total
The total number of data set exports.
DataSetExportTask
Description
Contains information about a data set export task.
Members
status
Required: Yes
Type: string
The status of the data set export task.
statusReason
If dataset exports failed, the failure reason will show here.
summary
Required: Yes
Type: DataSetExportSummary structure
A summary of the data set export task.
taskId
Required: Yes
Type: string
The identifier of the data set export task.
DataSetImportConfig
Description
Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.
Members
dataSets
Type: Array of DataSetImportItem structures
The data sets.
s3Location
The Amazon S3 location of the data sets.
DataSetImportItem
Description
Identifies a specific data set to import from an external location.
Members
dataSet
Required: Yes
Type: DataSet structure
The data set.
externalLocation
Required: Yes
Type: ExternalLocation structure
The location of the data set.
DataSetImportSummary
Description
Represents a summary of data set imports.
Members
failed
The number of data set imports that have failed.
inProgress
The number of data set imports that are in progress.
pending
The number of data set imports that are pending.
succeeded
The number of data set imports that have succeeded.
total
The total number of data set imports.
DataSetImportTask
Description
Contains information about a data set import task.
Members
status
Required: Yes
Type: string
The status of the data set import task.
statusReason
If dataset import failed, the failure reason will show here.
summary
Required: Yes
Type: DataSetImportSummary structure
A summary of the data set import task.
taskId
Required: Yes
Type: string
The identifier of the data set import task.
DataSetSummary
Description
A subset of the possible data set attributes.
Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the data set was created.
dataSetName
Required: Yes
Type: string
The name of the data set.
dataSetOrg
The type of data set. The only supported value is VSAM.
format
The format of the data set.
lastReferencedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data set was referenced.
lastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data set was updated.
DatasetDetailOrgAttributes
Description
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).
Members
gdg
Type: GdgDetailAttributes structure
The generation data group of the data set.
po
Type: PoDetailAttributes structure
The details of a PO type data set.
ps
Type: PsDetailAttributes structure
The details of a PS type data set.
vsam
Type: VsamDetailAttributes structure
The details of a VSAM data set.
DatasetOrgAttributes
Description
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).
Members
gdg
Type: GdgAttributes structure
The generation data group of the data set.
po
Type: PoAttributes structure
The details of a PO type data set.
ps
Type: PsAttributes structure
The details of a PS type data set.
vsam
Type: VsamAttributes structure
The details of a VSAM data set.
Definition
Description
The application definition for a particular application.
Members
content
The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.
s3Location
The S3 bucket that contains the application definition.
DeployedVersionSummary
Description
Contains a summary of a deployed application.
Members
applicationVersion
The version of the deployed application.
status
Required: Yes
Type: string
The status of the deployment.
statusReason
The reason for the reported status.
DeploymentSummary
Description
A subset of information about a specific deployment.
Members
applicationId
Required: Yes
Type: string
The unique identifier of the application.
applicationVersion
The version of the application.
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the deployment was created.
deploymentId
Required: Yes
Type: string
The unique identifier of the deployment.
environmentId
Required: Yes
Type: string
The unique identifier of the runtime environment.
status
Required: Yes
Type: string
The current status of the deployment.
statusReason
The reason for the reported status.
EfsStorageConfiguration
Description
Defines the storage configuration for an Amazon EFS file system.
Members
fileSystemId
Required: Yes
Type: string
The file system identifier.
mountPoint
Required: Yes
Type: string
The mount point for the file system.
EngineVersionsSummary
Description
A subset of information about the engine version for a specific application.
Members
engineType
Required: Yes
Type: string
The type of target platform for the application.
engineVersion
Required: Yes
Type: string
The version of the engine type used by the application.
EnvironmentSummary
Description
Contains a subset of the possible runtime environment attributes. Used in the environment list.
Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the runtime environment was created.
engineType
Required: Yes
Type: string
The target platform for the runtime environment.
engineVersion
Required: Yes
Type: string
The version of the runtime engine.
environmentArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of a particular runtime environment.
environmentId
Required: Yes
Type: string
The unique identifier of a particular runtime environment.
instanceType
Required: Yes
Type: string
The instance type of the runtime environment.
name
Required: Yes
Type: string
The name of the runtime environment.
networkType
The network type supported by the runtime environment.
status
Required: Yes
Type: string
The status of the runtime environment
ExecutionTimeoutException
Description
Failed to connect to server, or didn’t receive response within expected time period.
Members
message
Required: Yes
Type: string
ExternalLocation
Description
Defines an external storage location.
Members
s3Location
The URI of the Amazon S3 bucket.
FileBatchJobDefinition
Description
A file containing a batch job definition.
Members
fileName
Required: Yes
Type: string
The name of the file containing the batch job definition.
folderPath
The path to the file containing the batch job definition.
FileBatchJobIdentifier
Description
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.
Members
fileName
Required: Yes
Type: string
The file name for the batch job identifier.
folderPath
The relative path to the file name for the batch job identifier.
FsxStorageConfiguration
Description
Defines the storage configuration for an Amazon FSx file system.
Members
fileSystemId
Required: Yes
Type: string
The file system identifier.
mountPoint
Required: Yes
Type: string
The mount point for the file system.
GdgAttributes
Description
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.
Members
limit
The maximum number of generation data sets, up to 255, in a GDG.
rollDisposition
The disposition of the data set in the catalog.
GdgDetailAttributes
Description
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.
Members
limit
The maximum number of generation data sets, up to 255, in a GDG.
rollDisposition
The disposition of the data set in the catalog.
HighAvailabilityConfig
Description
Defines the details of a high availability configuration.
Members
desiredCapacity
The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
InternalServerException
Description
An unexpected error occurred during the processing of the request.
Members
message
Required: Yes
Type: string
retryAfterSeconds
The number of seconds to wait before retrying the request.
JobIdentifier
Description
Identifies a specific batch job.
Members
fileName
The name of the file that contains the batch job definition.
scriptName
The name of the script that contains the batch job definition.
JobStep
Description
Provides information related to a job step.
Members
procStepName
The name of a procedure step.
procStepNumber
The number of a procedure step.
stepCheckpoint
A registered step-level checkpoint identifier that can be used for restarting an Amazon Web Services Blu Age application batch job.
stepCheckpointStatus
The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
stepCheckpointTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
stepCondCode
The condition code of a step.
stepName
The name of a step.
stepNumber
The number of a step.
stepRestartable
Specifies if a step can be restarted or not.
JobStepRestartMarker
Description
Provides step/procedure step information for a restart batch job operation.
Members
fromProcStep
The procedure step name that a batch job was restarted from.
fromStep
Required: Yes
Type: string
The step name that a batch job was restarted from.
skip
The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.
stepCheckpoint
Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.
toProcStep
The procedure step name that a batch job was restarted to.
toStep
The step name that a batch job was restarted to.
LogGroupSummary
Description
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.
Members
logGroupName
Required: Yes
Type: string
The name of the log group.
logType
Required: Yes
Type: string
The type of log.
MaintenanceSchedule
Description
The information about the maintenance schedule.
Members
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the scheduled maintenance is to end.
startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the scheduled maintenance is to start.
PendingMaintenance
Description
The scheduled maintenance for a runtime engine.
Members
engineVersion
The specific runtime engine that the maintenance schedule applies to.
schedule
Type: MaintenanceSchedule structure
The maintenance schedule for the runtime engine version.
PoAttributes
Description
The supported properties for a PO type data set.
Members
encoding
The character set encoding of the data set.
format
Required: Yes
Type: string
The format of the data set records.
memberFileExtensions
Required: Yes
Type: Array of strings
An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.
PoDetailAttributes
Description
The supported properties for a PO type data set.
Members
encoding
Required: Yes
Type: string
The character set encoding of the data set.
format
Required: Yes
Type: string
The format of the data set records.
PrimaryKey
Description
The primary key for a KSDS data set.
Members
length
A strictly positive integer value representing the length of the primary key.
name
A name for the Primary Key.
offset
A positive integer value representing the offset to mark the start of the primary key in the record byte array.
PsAttributes
Description
The supported properties for a PS type data set.
Members
encoding
The character set encoding of the data set.
format
Required: Yes
Type: string
The format of the data set records.
PsDetailAttributes
Description
The supported properties for a PS type data set.
Members
encoding
Required: Yes
Type: string
The character set encoding of the data set.
format
Required: Yes
Type: string
The format of the data set records.
RecordLength
Description
The length of the records in the data set.
Members
max
The maximum record length. In case of fixed, both minimum and maximum are the same.
min
The minimum record length of a record.
ResourceNotFoundException
Description
The specified resource was not found.
Members
message
Required: Yes
Type: string
resourceId
The ID of the missing resource.
resourceType
The type of the missing resource.
RestartBatchJobIdentifier
Description
An identifier for the StartBatchJob API to show that it is a restart operation.
Members
executionId
Required: Yes
Type: string
The executionId from the StartBatchJob response when the job ran for the first time.
jobStepRestartMarker
Required: Yes
Type: JobStepRestartMarker structure
The step/procedure step information for a restart batch job operation.
S3BatchJobIdentifier
Description
A batch job identifier in which the batch jobs to run are identified by an Amazon S3 location.
Members
bucket
Required: Yes
Type: string
The Amazon S3 bucket that contains the batch job definitions.
identifier
Required: Yes
Type: JobIdentifier structure
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.
keyPrefix
The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
ScriptBatchJobDefinition
Description
A batch job definition contained in a script.
Members
scriptName
Required: Yes
Type: string
The name of the script containing the batch job definition.
ScriptBatchJobIdentifier
Description
A batch job identifier in which the batch job to run is identified by the script name.
Members
scriptName
Required: Yes
Type: string
The name of the script containing the batch job definition.
ServiceQuotaExceededException
Description
One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
Members
message
Required: Yes
Type: string
quotaCode
The identifier of the exceeded quota.
resourceId
The ID of the resource that is exceeding the quota limit.
resourceType
The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
serviceCode
A code that identifies the service that the exceeded quota belongs to.
ServiceUnavailableException
Description
Server cannot process the request at the moment.
Members
message
Required: Yes
Type: string
StorageConfiguration
Description
Defines the storage configuration for a runtime environment.
Members
efs
Type: EfsStorageConfiguration structure
Defines the storage configuration for an Amazon EFS file system.
fsx
Type: FsxStorageConfiguration structure
Defines the storage configuration for an Amazon FSx file system.
ThrottlingException
Description
The number of requests made exceeds the limit.
Members
message
Required: Yes
Type: string
quotaCode
The identifier of the throttled request.
retryAfterSeconds
The number of seconds to wait before retrying the request.
serviceCode
The identifier of the service that the throttled request was made to.
ValidationException
Description
One or more parameters provided in the request is not valid.
Members
fieldList
Type: Array of ValidationExceptionField structures
The list of fields that failed service validation.
message
Required: Yes
Type: string
reason
The reason why it failed service validation.
ValidationExceptionField
Description
Contains information about a validation exception field.
Members
message
Required: Yes
Type: string
The message of the exception field.
name
Required: Yes
Type: string
The name of the exception field.
VsamAttributes
Description
The attributes of a VSAM type data set.
Members
alternateKeys
Type: Array of AlternateKey structures
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.
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.
encoding
The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
format
Required: Yes
Type: string
The record format of the data set.
primaryKey
Type: PrimaryKey structure
The primary key of the data set.
VsamDetailAttributes
Description
The attributes of a VSAM type data set.
Members
alternateKeys
Type: Array of AlternateKey structures
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.
cacheAtStartup
If set to True, enforces loading the data set into cache before it’s used by the application.
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.
encoding
The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
primaryKey
Type: PrimaryKey structure
The primary key of the data set.
recordFormat
The record format of the data set.