AWS SDK for PHP 3.x

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\MainframeModernizationClient object 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.
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.
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 JCL files to restart a batch job.
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:

ListApplicationVersions
ListApplications
ListBatchJobDefinitions
ListBatchJobExecutions
ListDataSetImportHistory
ListDataSets
ListDeployments
ListEngineVersions
ListEnvironments

Operations

CancelBatchJobExecution

$result = $client->cancelBatchJobExecution([/* ... */]);
$promise = $client->cancelBatchJobExecutionAsync([/* ... */]);

Cancels the running of a specific batch job execution.

Parameter Syntax

$result = $client->cancelBatchJobExecution([
    'applicationId' => '<string>', // REQUIRED
    'executionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates a new application with given parameters. Requires an existing runtime environment and application definition file.

Parameter Syntax

$result = $client->createApplication([
    'clientToken' => '<string>',
    'definition' => [ // REQUIRED
        'content' => '<string>',
        's3Location' => '<string>',
    ],
    'description' => '<string>',
    'engineType' => 'microfocus|bluage', // REQUIRED
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

definition

: Required: Yes
: Type: Definition structure

The application definition for this application. You can specify either inline JSON or an S3 bucket location.

description

: Type: string

The description of the application.

engineType

: Required: Yes
: Type: string

The type of the target platform for this application.

kmsKeyId

: Type: string

The identifier of a customer managed key.

name

: Required: Yes
: Type: string

The unique identifier of the application.

roleArn

: Type: string

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' => '<string>',
    'applicationId' => '<string>',
    'applicationVersion' => <integer>,
]

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

: Required: Yes
: Type: int

The version number of the application.

Errors

ServiceQuotaExceededException:: One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

CreateDataSetImportTask

$result = $client->createDataSetImportTask([/* ... */]);
$promise = $client->createDataSetImportTaskAsync([/* ... */]);

Starts a data set import task for a specific application.

Parameter Syntax

$result = $client->createDataSetImportTask([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'importConfig' => [ // REQUIRED
        'dataSets' => [
            [
                'dataSet' => [ // REQUIRED
                    'datasetName' => '<string>', // REQUIRED
                    'datasetOrg' => [ // REQUIRED
                        'gdg' => [
                            'limit' => <integer>,
                            'rollDisposition' => '<string>',
                        ],
                        'po' => [
                            'encoding' => '<string>',
                            'format' => '<string>', // REQUIRED
                            'memberFileExtensions' => ['<string>', ...], // REQUIRED
                        ],
                        'ps' => [
                            'encoding' => '<string>',
                            'format' => '<string>', // REQUIRED
                        ],
                        'vsam' => [
                            'alternateKeys' => [
                                [
                                    'allowDuplicates' => true || false,
                                    'length' => <integer>, // REQUIRED
                                    'name' => '<string>',
                                    'offset' => <integer>, // REQUIRED
                                ],
                                // ...
                            ],
                            'compressed' => true || false,
                            'encoding' => '<string>',
                            'format' => '<string>', // REQUIRED
                            'primaryKey' => [
                                'length' => <integer>, // REQUIRED
                                'name' => '<string>',
                                'offset' => <integer>, // REQUIRED
                            ],
                        ],
                    ],
                    'recordLength' => [ // REQUIRED
                        'max' => <integer>, // REQUIRED
                        'min' => <integer>, // REQUIRED
                    ],
                    'relativePath' => '<string>',
                    'storageType' => '<string>',
                ],
                'externalLocation' => [ // REQUIRED
                    's3Location' => '<string>',
                ],
            ],
            // ...
        ],
        's3Location' => '<string>',
    ],
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application for which you want to import data sets.

clientToken

: Type: string

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' => '<string>',
]

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

ResourceNotFoundException:: The specified resource was not found.
ServiceQuotaExceededException:: One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

CreateDeployment

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

Creates and starts a deployment to deploy an application into a runtime environment.

Parameter Syntax

$result = $client->createDeployment([
    'applicationId' => '<string>', // REQUIRED
    'applicationVersion' => <integer>, // REQUIRED
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The application identifier.

applicationVersion

: Required: Yes
: Type: int

The version of the application to deploy.

clientToken

: Type: string

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' => '<string>',
]

Result Details

Members

deploymentId

: Required: Yes
: Type: string

The unique identifier of the deployment.

Errors

ResourceNotFoundException:: The specified resource was not found.
ServiceQuotaExceededException:: One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Creates a runtime environment for a given runtime engine.

Parameter Syntax

$result = $client->createEnvironment([
    'clientToken' => '<string>',
    'description' => '<string>',
    'engineType' => 'microfocus|bluage', // REQUIRED
    'engineVersion' => '<string>',
    'highAvailabilityConfig' => [
        'desiredCapacity' => <integer>, // REQUIRED
    ],
    'instanceType' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'preferredMaintenanceWindow' => '<string>',
    'publiclyAccessible' => true || false,
    'securityGroupIds' => ['<string>', ...],
    'storageConfigurations' => [
        [
            'efs' => [
                'fileSystemId' => '<string>', // REQUIRED
                'mountPoint' => '<string>', // REQUIRED
            ],
            'fsx' => [
                'fileSystemId' => '<string>', // REQUIRED
                'mountPoint' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

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

: Type: string

The description of the runtime environment.

engineType

: Required: Yes
: Type: string

The engine type for the runtime environment.

engineVersion

: Type: string

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

: Type: string

The identifier of a customer managed key.

name

: Required: Yes
: Type: string

The name of the runtime environment. Must be unique within the account.

preferredMaintenanceWindow

: Type: string

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

publiclyAccessible

: Type: boolean

Specifies whether the runtime environment is publicly accessible.

securityGroupIds

: Type: Array of strings

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

: Type: Array of strings

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' => '<string>',
]

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.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes a specific application. You cannot delete a running application.

Parameter Syntax

$result = $client->deleteApplication([
    'applicationId' => '<string>', // 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

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

DeleteApplicationFromEnvironment

$result = $client->deleteApplicationFromEnvironment([/* ... */]);
$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 = $client->deleteApplicationFromEnvironment([
    'applicationId' => '<string>', // REQUIRED
    'environmentId' => '<string>', // 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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$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 = $client->deleteEnvironment([
    'environmentId' => '<string>', // 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

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Describes the details of a specific application.

Parameter Syntax

$result = $client->getApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The identifier of the application.

Result Syntax

[
    'applicationArn' => '<string>',
    'applicationId' => '<string>',
    'creationTime' => <DateTime>,
    'deployedVersion' => [
        'applicationVersion' => <integer>,
        'status' => 'Deploying|Succeeded|Failed|Updating Deployment',
        'statusReason' => '<string>',
    ],
    'description' => '<string>',
    'engineType' => 'microfocus|bluage',
    'environmentId' => '<string>',
    'kmsKeyId' => '<string>',
    'lastStartTime' => <DateTime>,
    'latestVersion' => [
        'applicationVersion' => <integer>,
        'creationTime' => <DateTime>,
        'status' => 'Creating|Available|Failed',
        'statusReason' => '<string>',
    ],
    'listenerArns' => ['<string>', ...],
    'listenerPorts' => [<integer>, ...],
    'loadBalancerDnsName' => '<string>',
    'logGroups' => [
        [
            'logGroupName' => '<string>',
            'logType' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'roleArn' => '<string>',
    'status' => 'Creating|Created|Available|Ready|Starting|Running|Stopping|Stopped|Failed|Deleting|Deleting From Environment',
    'statusReason' => '<string>',
    'tags' => ['<string>', ...],
    'targetGroupArns' => ['<string>', ...],
]

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

: Type: string

The description of the application.

engineType

: Required: Yes
: Type: string

The type of the target platform for the application.

environmentId

: Type: string

The identifier of the runtime environment where you want to deploy the application.

kmsKeyId

: Type: string

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

: Type: Array of strings

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

: Type: Array of ints

The port associated with the network load balancer listener created in your Amazon Web Services account.

loadBalancerDnsName

: Type: string

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

: Type: string

The Amazon Resource Name (ARN) of the role associated with the application.

status

: Required: Yes
: Type: string

The status of the application.

statusReason

: Type: string

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

: Type: Array of strings

Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetApplicationVersion

$result = $client->getApplicationVersion([/* ... */]);
$promise = $client->getApplicationVersionAsync([/* ... */]);

Returns details about a specific version of a specific application.

Parameter Syntax

$result = $client->getApplicationVersion([
    'applicationId' => '<string>', // REQUIRED
    'applicationVersion' => <integer>, // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

applicationVersion

: Required: Yes
: Type: int

The specific version of the application.

Result Syntax

[
    'applicationVersion' => <integer>,
    'creationTime' => <DateTime>,
    'definitionContent' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'status' => 'Creating|Available|Failed',
    'statusReason' => '<string>',
]

Result Details

Members

applicationVersion

: Required: Yes
: Type: int

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

: Type: string

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

: Type: string

The reason for the reported status.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetBatchJobExecution

$result = $client->getBatchJobExecution([/* ... */]);
$promise = $client->getBatchJobExecutionAsync([/* ... */]);

Gets the details of a specific batch job execution for a specific application.

Parameter Syntax

$result = $client->getBatchJobExecution([
    'applicationId' => '<string>', // REQUIRED
    'executionId' => '<string>', // 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' => '<string>',
    'batchJobIdentifier' => [
        'fileBatchJobIdentifier' => [
            'fileName' => '<string>',
            'folderPath' => '<string>',
        ],
        'restartBatchJobIdentifier' => [
            'executionId' => '<string>',
            'jobStepRestartMarker' => [
                'fromProcStep' => '<string>',
                'fromStep' => '<string>',
                'toProcStep' => '<string>',
                'toStep' => '<string>',
            ],
        ],
        's3BatchJobIdentifier' => [
            'bucket' => '<string>',
            'identifier' => [
                'fileName' => '<string>',
                'scriptName' => '<string>',
            ],
            'keyPrefix' => '<string>',
        ],
        'scriptBatchJobIdentifier' => [
            'scriptName' => '<string>',
        ],
    ],
    'endTime' => <DateTime>,
    'executionId' => '<string>',
    'jobId' => '<string>',
    'jobName' => '<string>',
    'jobStepRestartMarker' => [
        'fromProcStep' => '<string>',
        'fromStep' => '<string>',
        'toProcStep' => '<string>',
        'toStep' => '<string>',
    ],
    'jobType' => 'VSE|JES2|JES3',
    'jobUser' => '<string>',
    'returnCode' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'Submitting|Holding|Dispatching|Running|Cancelling|Cancelled|Succeeded|Failed|Purged|Succeeded With Warning',
    'statusReason' => '<string>',
]

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

: Type: string

The unique identifier for this batch job.

jobName

: Type: string

The name of this batch job.

jobStepRestartMarker

: Type: JobStepRestartMarker structure

The restart steps information for the most recent restart operation.

jobType

: Type: string

The type of job.

jobUser

: Type: string

The user for the job.

returnCode

: Type: string

The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

startTime

: 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

: Type: string

The reason for the reported status.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetDataSetDetails

$result = $client->getDataSetDetails([/* ... */]);
$promise = $client->getDataSetDetailsAsync([/* ... */]);

Gets the details of a specific data set.

Parameter Syntax

$result = $client->getDataSetDetails([
    'applicationId' => '<string>', // REQUIRED
    'dataSetName' => '<string>', // 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' => <integer>,
    'creationTime' => <DateTime>,
    'dataSetName' => '<string>',
    'dataSetOrg' => [
        'gdg' => [
            'limit' => <integer>,
            'rollDisposition' => '<string>',
        ],
        'po' => [
            'encoding' => '<string>',
            'format' => '<string>',
        ],
        'ps' => [
            'encoding' => '<string>',
            'format' => '<string>',
        ],
        'vsam' => [
            'alternateKeys' => [
                [
                    'allowDuplicates' => true || false,
                    'length' => <integer>,
                    'name' => '<string>',
                    'offset' => <integer>,
                ],
                // ...
            ],
            'cacheAtStartup' => true || false,
            'compressed' => true || false,
            'encoding' => '<string>',
            'primaryKey' => [
                'length' => <integer>,
                'name' => '<string>',
                'offset' => <integer>,
            ],
            'recordFormat' => '<string>',
        ],
    ],
    'fileSize' => <integer>,
    'lastReferencedTime' => <DateTime>,
    'lastUpdatedTime' => <DateTime>,
    'location' => '<string>',
    'recordLength' => <integer>,
]

Result Details

Members

blocksize

: Type: int

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

: Type: long (int|float)

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

: Type: string

The location where the data set is stored.

recordLength

: Type: int

The length of records in the data set.

Errors

ResourceNotFoundException:: The specified resource was not found.
ExecutionTimeoutException:: Failed to connect to server, or didn’t receive response within expected time period.
ServiceUnavailableException:: Server cannot process the request at the moment.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetDataSetImportTask

$result = $client->getDataSetImportTask([/* ... */]);
$promise = $client->getDataSetImportTaskAsync([/* ... */]);

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

Parameter Syntax

$result = $client->getDataSetImportTask([
    'applicationId' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The application identifier.

taskId

: Required: Yes
: Type: string

The task identifier returned by the CreateDataSetImportTask operation.

Result Syntax

[
    'status' => 'Creating|Running|Completed|Failed',
    'summary' => [
        'failed' => <integer>,
        'inProgress' => <integer>,
        'pending' => <integer>,
        'succeeded' => <integer>,
        'total' => <integer>,
    ],
    'taskId' => '<string>',
]

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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Gets details of a specific deployment with a given deployment identifier.

Parameter Syntax

$result = $client->getDeployment([
    'applicationId' => '<string>', // REQUIRED
    'deploymentId' => '<string>', // 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' => '<string>',
    'applicationVersion' => <integer>,
    'creationTime' => <DateTime>,
    'deploymentId' => '<string>',
    'environmentId' => '<string>',
    'status' => 'Deploying|Succeeded|Failed|Updating Deployment',
    'statusReason' => '<string>',
]

Result Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

applicationVersion

: Required: Yes
: Type: int

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

: Type: string

The reason for the reported status.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Describes a specific runtime environment.

Parameter Syntax

$result = $client->getEnvironment([
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

environmentId

: Required: Yes
: Type: string

The unique identifier of the runtime environment.

Result Syntax

[
    'actualCapacity' => <integer>,
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'engineType' => 'microfocus|bluage',
    'engineVersion' => '<string>',
    'environmentArn' => '<string>',
    'environmentId' => '<string>',
    'highAvailabilityConfig' => [
        'desiredCapacity' => <integer>,
    ],
    'instanceType' => '<string>',
    'kmsKeyId' => '<string>',
    'loadBalancerArn' => '<string>',
    'name' => '<string>',
    'pendingMaintenance' => [
        'engineVersion' => '<string>',
        'schedule' => [
            'endTime' => <DateTime>,
            'startTime' => <DateTime>,
        ],
    ],
    'preferredMaintenanceWindow' => '<string>',
    'publiclyAccessible' => true || false,
    'securityGroupIds' => ['<string>', ...],
    'status' => 'Creating|Available|Updating|Deleting|Failed',
    'statusReason' => '<string>',
    'storageConfigurations' => [
        [
            'efs' => [
                'fileSystemId' => '<string>',
                'mountPoint' => '<string>',
            ],
            'fsx' => [
                'fileSystemId' => '<string>',
                'mountPoint' => '<string>',
            ],
        ],
        // ...
    ],
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'vpcId' => '<string>',
]

Result Details

Members

actualCapacity

: Type: int

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

: Type: string

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

: Type: string

The identifier of a customer managed key.

loadBalancerArn

: Type: string

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.

pendingMaintenance

: Type: PendingMaintenance structure

Indicates the pending maintenance scheduled on this environment.

preferredMaintenanceWindow

: Type: string

The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

publiclyAccessible

: Type: boolean

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.

statusReason

: Type: string

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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

GetSignedBluinsightsUrl

$result = $client->getSignedBluinsightsUrl([/* ... */]);
$promise = $client->getSignedBluinsightsUrlAsync([/* ... */]);

Gets a single sign-on URL that can be used to connect to AWS Blu Insights.

Parameter Syntax

$result = $client->getSignedBluinsightsUrl([
]);

Parameter Details

Members

Result Syntax

[
    'signedBiUrl' => '<string>',
]

Result Details

Members

signedBiUrl

: Required: Yes
: Type: string

Single sign-on AWS Blu Insights URL.

Errors

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListApplicationVersions

$result = $client->listApplicationVersions([/* ... */]);
$promise = $client->listApplicationVersionsAsync([/* ... */]);

Returns a list of the application versions for a specific application.

Parameter Syntax

$result = $client->listApplicationVersions([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

maxResults

: Type: int

The maximum number of application versions to return.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Result Syntax

[
    'applicationVersions' => [
        [
            'applicationVersion' => <integer>,
            'creationTime' => <DateTime>,
            'status' => 'Creating|Available|Failed',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

applicationVersions

: Required: Yes
: Type: Array of ApplicationVersionSummary structures

The list of application versions.

nextToken

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListApplications

$result = $client->listApplications([/* ... */]);
$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 = $client->listApplications([
    'environmentId' => '<string>',
    'maxResults' => <integer>,
    'names' => ['<string>', ...],
    'nextToken' => '<string>',
]);

Parameter Details

Members

environmentId

: Type: string

The unique identifier of the runtime environment where the applications are deployed.

maxResults

: Type: int

The maximum number of applications to return.

names

: Type: Array of strings

The names of the applications.

nextToken

: Type: string

A pagination token to control the number of applications displayed in the list.

Result Syntax

[
    'applications' => [
        [
            'applicationArn' => '<string>',
            'applicationId' => '<string>',
            'applicationVersion' => <integer>,
            'creationTime' => <DateTime>,
            'deploymentStatus' => 'Deploying|Deployed',
            'description' => '<string>',
            'engineType' => 'microfocus|bluage',
            'environmentId' => '<string>',
            'lastStartTime' => <DateTime>,
            'name' => '<string>',
            'roleArn' => '<string>',
            'status' => 'Creating|Created|Available|Ready|Starting|Running|Stopping|Stopped|Failed|Deleting|Deleting From Environment',
            'versionStatus' => 'Creating|Available|Failed',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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

: Type: string

A pagination token that's returned when the response doesn't contain all applications.

Errors

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListBatchJobDefinitions

$result = $client->listBatchJobDefinitions([/* ... */]);
$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 = $client->listBatchJobDefinitions([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'prefix' => '<string>',
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The identifier of the application.

maxResults

: Type: int

The maximum number of batch job definitions to return.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

prefix

: Type: string

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' => '<string>',
                'folderPath' => '<string>',
            ],
            'scriptBatchJobDefinition' => [
                'scriptName' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

batchJobDefinitions

: Required: Yes
: Type: Array of BatchJobDefinition structures

The list of batch job definitions.

nextToken

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListBatchJobExecutions

$result = $client->listBatchJobExecutions([/* ... */]);
$promise = $client->listBatchJobExecutionsAsync([/* ... */]);

Lists historical, current, and scheduled batch job executions for a specific application.

Parameter Syntax

$result = $client->listBatchJobExecutions([
    'applicationId' => '<string>', // REQUIRED
    'executionIds' => ['<string>', ...],
    'jobName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    '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

: Type: Array of strings

The unique identifier of each batch job execution.

jobName

: Type: string

The name of each batch job execution.

maxResults

: Type: int

The maximum number of batch job executions to return.

nextToken

: Type: string

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

: Type: string

The status of the batch job executions.

Result Syntax

[
    'batchJobExecutions' => [
        [
            'applicationId' => '<string>',
            'batchJobIdentifier' => [
                'fileBatchJobIdentifier' => [
                    'fileName' => '<string>',
                    'folderPath' => '<string>',
                ],
                'restartBatchJobIdentifier' => [
                    'executionId' => '<string>',
                    'jobStepRestartMarker' => [
                        'fromProcStep' => '<string>',
                        'fromStep' => '<string>',
                        'toProcStep' => '<string>',
                        'toStep' => '<string>',
                    ],
                ],
                's3BatchJobIdentifier' => [
                    'bucket' => '<string>',
                    'identifier' => [
                        'fileName' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'keyPrefix' => '<string>',
                ],
                'scriptBatchJobIdentifier' => [
                    'scriptName' => '<string>',
                ],
            ],
            'endTime' => <DateTime>,
            'executionId' => '<string>',
            'jobId' => '<string>',
            'jobName' => '<string>',
            'jobType' => 'VSE|JES2|JES3',
            'returnCode' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'Submitting|Holding|Dispatching|Running|Cancelling|Cancelled|Succeeded|Failed|Purged|Succeeded With Warning',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

batchJobExecutions

: Required: Yes
: Type: Array of BatchJobExecutionSummary structures

Returns a list of batch job executions for an application.

nextToken

: Type: string

A pagination token that's returned when the response doesn't contain all batch job executions.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListBatchJobRestartPoints

$result = $client->listBatchJobRestartPoints([/* ... */]);
$promise = $client->listBatchJobRestartPointsAsync([/* ... */]);

Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.

Parameter Syntax

$result = $client->listBatchJobRestartPoints([
    'applicationId' => '<string>', // REQUIRED
    'executionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

executionId

: Required: Yes
: Type: string

The unique identifier of each batch job execution.

Result Syntax

[
    'batchJobSteps' => [
        [
            'procStepName' => '<string>',
            'procStepNumber' => <integer>,
            'stepCondCode' => '<string>',
            'stepName' => '<string>',
            'stepNumber' => <integer>,
            '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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListDataSetImportHistory

$result = $client->listDataSetImportHistory([/* ... */]);
$promise = $client->listDataSetImportHistoryAsync([/* ... */]);

Lists the data set imports for the specified application.

Parameter Syntax

$result = $client->listDataSetImportHistory([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application.

maxResults

: Type: int

The maximum number of objects to return.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Result Syntax

[
    'dataSetImportTasks' => [
        [
            'status' => 'Creating|Running|Completed|Failed',
            'statusReason' => '<string>',
            'summary' => [
                'failed' => <integer>,
                'inProgress' => <integer>,
                'pending' => <integer>,
                'succeeded' => <integer>,
                'total' => <integer>,
            ],
            'taskId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

dataSetImportTasks

: Required: Yes
: Type: Array of DataSetImportTask structures

The data set import tasks.

nextToken

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListDataSets

$result = $client->listDataSets([/* ... */]);
$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 = $client->listDataSets([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nameFilter' => '<string>',
    'nextToken' => '<string>',
    'prefix' => '<string>',
]);

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

: Type: int

The maximum number of objects to return.

nameFilter

: Type: string

Filter dataset name matching the specified pattern. Can use * and % as wild cards.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

prefix

: Type: string

The prefix of the data set name, which you can use to filter the list of data sets.

Result Syntax

[
    'dataSets' => [
        [
            'creationTime' => <DateTime>,
            'dataSetName' => '<string>',
            'dataSetOrg' => '<string>',
            'format' => '<string>',
            'lastReferencedTime' => <DateTime>,
            'lastUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ResourceNotFoundException:: The specified resource was not found.
ExecutionTimeoutException:: Failed to connect to server, or didn’t receive response within expected time period.
ServiceUnavailableException:: Server cannot process the request at the moment.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListDeployments

$result = $client->listDeployments([/* ... */]);
$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 = $client->listDeployments([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The application identifier.

maxResults

: Type: int

The maximum number of objects to return.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Result Syntax

[
    'deployments' => [
        [
            'applicationId' => '<string>',
            'applicationVersion' => <integer>,
            'creationTime' => <DateTime>,
            'deploymentId' => '<string>',
            'environmentId' => '<string>',
            'status' => 'Deploying|Succeeded|Failed|Updating Deployment',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

deployments

: Required: Yes
: Type: Array of DeploymentSummary structures

The list of deployments that is returned.

nextToken

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListEngineVersions

$result = $client->listEngineVersions([/* ... */]);
$promise = $client->listEngineVersionsAsync([/* ... */]);

Lists the available engine versions.

Parameter Syntax

$result = $client->listEngineVersions([
    'engineType' => 'microfocus|bluage',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

engineType

: Type: string

The type of target platform.

maxResults

: Type: int

The maximum number of objects to return.

nextToken

: Type: string

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Result Syntax

[
    'engineVersions' => [
        [
            'engineType' => '<string>',
            'engineVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

engineVersions

: Required: Yes
: Type: Array of EngineVersionsSummary structures

Returns the engine versions.

nextToken

: Type: string

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Errors

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

Lists the runtime environments.

Parameter Syntax

$result = $client->listEnvironments([
    'engineType' => 'microfocus|bluage',
    'maxResults' => <integer>,
    'names' => ['<string>', ...],
    'nextToken' => '<string>',
]);

Parameter Details

Members

engineType

: Type: string

The engine type for the runtime environment.

maxResults

: Type: int

The maximum number of runtime environments to return.

names

: Type: Array of strings

The names of the runtime environments. Must be unique within the account.

nextToken

: Type: string

A pagination token to control the number of runtime environments displayed in the list.

Result Syntax

[
    'environments' => [
        [
            'creationTime' => <DateTime>,
            'engineType' => 'microfocus|bluage',
            'engineVersion' => '<string>',
            'environmentArn' => '<string>',
            'environmentId' => '<string>',
            'instanceType' => '<string>',
            'name' => '<string>',
            'status' => 'Creating|Available|Updating|Deleting|Failed',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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

: Type: string

A pagination token that's returned when the response doesn't contain all the runtime environments.

Errors

ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

StartApplication

$result = $client->startApplication([/* ... */]);
$promise = $client->startApplicationAsync([/* ... */]);

Starts an application that is currently stopped.

Parameter Syntax

$result = $client->startApplication([
    'applicationId' => '<string>', // 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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

StartBatchJob

$result = $client->startBatchJob([/* ... */]);
$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 = $client->startBatchJob([
    'applicationId' => '<string>', // REQUIRED
    'batchJobIdentifier' => [ // REQUIRED
        'fileBatchJobIdentifier' => [
            'fileName' => '<string>', // REQUIRED
            'folderPath' => '<string>',
        ],
        'restartBatchJobIdentifier' => [
            'executionId' => '<string>', // REQUIRED
            'jobStepRestartMarker' => [ // REQUIRED
                'fromProcStep' => '<string>',
                'fromStep' => '<string>', // REQUIRED
                'toProcStep' => '<string>',
                'toStep' => '<string>',
            ],
        ],
        's3BatchJobIdentifier' => [
            'bucket' => '<string>', // REQUIRED
            'identifier' => [ // REQUIRED
                'fileName' => '<string>',
                'scriptName' => '<string>',
            ],
            'keyPrefix' => '<string>',
        ],
        'scriptBatchJobIdentifier' => [
            'scriptName' => '<string>', // REQUIRED
        ],
    ],
    'jobParams' => ['<string>', ...],
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application associated with this batch job.

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' => '<string>',
]

Result Details

Members

executionId

: Required: Yes
: Type: string

The unique identifier of this execution of the batch job.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

StopApplication

$result = $client->stopApplication([/* ... */]);
$promise = $client->stopApplicationAsync([/* ... */]);

Stops a running application.

Parameter Syntax

$result = $client->stopApplication([
    'applicationId' => '<string>', // REQUIRED
    'forceStop' => true || false,
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application you want to stop.

forceStop

: Type: boolean

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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // 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

ResourceNotFoundException:: The specified resource was not found.
ServiceQuotaExceededException:: One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // 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

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates an application and creates a new version.

Parameter Syntax

$result = $client->updateApplication([
    'applicationId' => '<string>', // REQUIRED
    'currentApplicationVersion' => <integer>, // REQUIRED
    'definition' => [
        'content' => '<string>',
        's3Location' => '<string>',
    ],
    'description' => '<string>',
]);

Parameter Details

Members

applicationId

: Required: Yes
: Type: string

The unique identifier of the application you want to update.

currentApplicationVersion

: Required: Yes
: Type: int

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

: Type: string

The description of the application to update.

Result Syntax

[
    'applicationVersion' => <integer>,
]

Result Details

Members

applicationVersion

: Required: Yes
: Type: int

The new version of the application.

Errors

ResourceNotFoundException:: The specified resource was not found.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: An unexpected error occurred during the processing of the request.

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

Updates the configuration details for a specific runtime environment.

Parameter Syntax

$result = $client->updateEnvironment([
    'applyDuringMaintenanceWindow' => true || false,
    'desiredCapacity' => <integer>,
    'engineVersion' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'forceUpdate' => true || false,
    'instanceType' => '<string>',
    'preferredMaintenanceWindow' => '<string>',
]);

Parameter Details

Members

applyDuringMaintenanceWindow

: Type: boolean

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

desiredCapacity

: Type: int

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

engineVersion

: Type: string

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

: Type: boolean

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

instanceType

: Type: string

The instance type for the runtime environment to update.

preferredMaintenanceWindow

: Type: string

If you do not provide a value, a random system-generated value will be assigned.

Result Syntax

[
    'environmentId' => '<string>',
]

Result Details

Members

environmentId

: Required: Yes
: Type: string

The unique identifier of the runtime environment that was updated.

Errors

ResourceNotFoundException:: The specified resource was not found.
ServiceQuotaExceededException:: One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
ThrottlingException:: The number of requests made exceeds the limit.
AccessDeniedException:: The account or role doesn't have the right permissions to make the request.
ConflictException:: The parameters provided in the request conflict with existing resources.
ValidationException:: One or more parameters provided in the request is not valid.
InternalServerException:: 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

: Type: boolean

Indicates whether the alternate key values are supposed to be unique for the given data set.

length

: Required: Yes
: Type: int

A strictly positive integer value representing the length of the alternate key.

name

: Type: string

The name of the alternate key.

offset

: Required: Yes
: Type: int

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

: Required: Yes
: Type: int

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

: Type: string

Indicates either an ongoing deployment or if the application has ever deployed successfully.

description

: Type: string

The description of the application.

engineType

: Required: Yes
: Type: string

The type of the target platform for this application.

environmentId

: Type: string

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

: Type: string

The Amazon Resource Name (ARN) of the role associated with the application.

status

: Required: Yes
: Type: string

The status of the application.

versionStatus

: Type: string

Indicates the status of the latest version of the application.

ApplicationVersionSummary

Description

Defines an application version summary.

Members

applicationVersion

: Required: Yes
: Type: int

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

: Type: string

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

: Type: string

The unique identifier of a particular batch job.

jobName

: Type: string

The name of a particular batch job.

jobType

: Type: string

The type of a particular batch job execution.

returnCode

: Type: string

The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

startTime

: 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 execution ID 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

: Type: string

The ID of the conflicting resource.

resourceType

: Type: string

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

: Type: string

The relative location of the data set in the database or file system.

storageType

: Type: string

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.

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

: Type: string

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

: Required: Yes
: Type: int

The number of data set imports that have failed.

inProgress

: Required: Yes
: Type: int

The number of data set imports that are in progress.

pending

: Required: Yes
: Type: int

The number of data set imports that are pending.

succeeded

: Required: Yes
: Type: int

The number of data set imports that have succeeded.

total

: Required: Yes
: Type: int

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

: Type: string

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

: Type: string

The type of data set. The only supported value is VSAM.

format

: Type: string

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

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

: Type: string

The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

s3Location

: Type: string

The S3 bucket that contains the application definition.

DeployedVersionSummary

Description

Contains a summary of a deployed application.

Members

applicationVersion

: Required: Yes
: Type: int

The version of the deployed application.

status

: Required: Yes
: Type: string

The status of the deployment.

statusReason

: Type: string

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

: Required: Yes
: Type: int

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

: Type: string

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.

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

: Type: string

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

: Type: string

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

: Type: string

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

: Type: int

The maximum number of generation data sets, up to 255, in a GDG.

rollDisposition

: Type: string

The disposition of the data set in the catalog.

GdgDetailAttributes

Description

Members

limit

: Type: int

The maximum number of generation data sets, up to 255, in a GDG.

rollDisposition

: Type: string

The disposition of the data set in the catalog.

HighAvailabilityConfig

Description

Defines the details of a high availability configuration.

Members

desiredCapacity

: Required: Yes
: Type: int

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

: Type: int

The number of seconds to wait before retrying the request.

JobIdentifier

Description

Identifies a specific batch job.

Members

fileName

: Type: string

The name of the file that contains the batch job definition.

scriptName

: Type: string

The name of the script that contains the batch job definition.

JobStep

Description

Provides information related to a job step.

Members

procStepName

: Type: string

The name of a procedure step.

procStepNumber

: Type: int

The number of a procedure step.

stepCondCode

: Type: string

The condition code of a step.

stepName

: Type: string

The name of a step.

stepNumber

: Type: int

The number of a step.

stepRestartable

: Type: boolean

Specifies if a step can be restarted or not.

JobStepRestartMarker

Description

Provides restart step information for the most recent restart operation.

Members

fromProcStep

: Type: string

The procedure step name that a job was restarted from.

fromStep

: Required: Yes
: Type: string

The step name that a batch job restart was from.

toProcStep

: Type: string

The procedure step name that a batch job was restarted to.

toStep

: Type: string

The step name that a 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

: Type: string

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

: Type: string

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

: Required: Yes
: Type: int

A strictly positive integer value representing the length of the primary key.

name

: Type: string

A name for the Primary Key.

offset

: Required: Yes
: Type: int

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

: Type: string

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

: Required: Yes
: Type: int

The maximum record length. In case of fixed, both minimum and maximum are the same.

min

: Required: Yes
: Type: int

The minimum record length of a record.

ResourceNotFoundException

Description

The specified resource was not found.

Members

message

: Required: Yes
: Type: string

resourceId

: Type: string

The ID of the missing resource.

resourceType

: Type: string

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 restart step information for the most recent restart 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

: Type: string

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

: Type: string

The identifier of the exceeded quota.

resourceId

: Type: string

The ID of the resource that is exceeding the quota limit.

resourceType

: Type: string

The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.

serviceCode

: Type: string

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

: Type: string

The identifier of the throttled request.

retryAfterSeconds

: Type: int

The number of seconds to wait before retrying the request.

serviceCode

: Type: string

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

: Type: string

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

: Type: boolean

Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

encoding

: Type: string

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

cacheAtStartup

: Type: boolean

If set to True, enforces loading the data set into cache before it’s used by the application.

compressed

: Type: boolean

Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

encoding

: Type: string

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

: Type: string

The record format of the data set.

AWSMainframeModernization 2021-04-28

Operation Summary

Paginators

Operations

CancelBatchJobExecution

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDataSetImportTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDeployment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteApplicationFromEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetApplicationVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors