list_batch_job_definitions

list_batch_job_definitions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_job_definitions(
    applicationId='string',
    maxResults=123,
    nextToken='string',
    prefix='string'
)

Parameters

• applicationId (string) --

  [REQUIRED]

  The identifier of the application.

• maxResults (integer) -- The maximum number of batch job definitions to return.
• nextToken (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 (string) -- If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

Return type

dict

Returns

Response Syntax

{
    'batchJobDefinitions': [
        {
            'fileBatchJobDefinition': {
                'fileName': 'string',
                'folderPath': 'string'
            },
            'scriptBatchJobDefinition': {
                'scriptName': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • batchJobDefinitions (list) --

    The list of batch job definitions.

    • (dict) --

      Defines the details of a batch job.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: fileBatchJobDefinition, scriptBatchJobDefinition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • fileBatchJobDefinition (dict) --

        Specifies a file containing a batch job definition.

        • fileName (string) --

          The name of the file containing the batch job definition.

        • folderPath (string) --

          The path to the file containing the batch job definition.

      • scriptBatchJobDefinition (dict) --

        A script containing a batch job definition.

        • scriptName (string) --

          The name of the script containing the batch job definition.

  • nextToken (string) --

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

Exceptions

• MainframeModernization.Client.exceptions.ValidationException
• MainframeModernization.Client.exceptions.InternalServerException
• MainframeModernization.Client.exceptions.AccessDeniedException
• MainframeModernization.Client.exceptions.ThrottlingException
• MainframeModernization.Client.exceptions.ResourceNotFoundException