get_application

MainframeModernization.Client.get_application(**kwargs)

Describes the details of a specific application.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    applicationId='string'
)
Parameters
applicationId (string) --

[REQUIRED]

The identifier of the application.

Return type
dict
Returns
Response Syntax
{
    'applicationArn': 'string',
    'applicationId': 'string',
    'creationTime': datetime(2015, 1, 1),
    'deployedVersion': {
        'applicationVersion': 123,
        'status': 'Deploying'|'Succeeded'|'Failed',
        'statusReason': 'string'
    },
    'description': 'string',
    'engineType': 'microfocus'|'bluage',
    'environmentId': 'string',
    'kmsKeyId': 'string',
    'lastStartTime': datetime(2015, 1, 1),
    'latestVersion': {
        'applicationVersion': 123,
        'creationTime': datetime(2015, 1, 1),
        'status': 'Creating'|'Available'|'Failed',
        'statusReason': 'string'
    },
    'listenerArns': [
        'string',
    ],
    'listenerPorts': [
        123,
    ],
    'loadBalancerDnsName': 'string',
    'logGroups': [
        {
            'logGroupName': 'string',
            'logType': 'string'
        },
    ],
    'name': 'string',
    'status': 'Creating'|'Created'|'Available'|'Ready'|'Starting'|'Running'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Deleting From Environment',
    'statusReason': 'string',
    'tags': {
        'string': 'string'
    },
    'targetGroupArns': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • applicationArn (string) --

      The Amazon Resource Name (ARN) of the application.

    • applicationId (string) --

      The identifier of the application.

    • creationTime (datetime) --

      The timestamp when this application was created.

    • deployedVersion (dict) --

      The version of the application that is deployed.

      • applicationVersion (integer) --

        The version of the deployed application.

      • status (string) --

        The status of the deployment.

      • statusReason (string) --

        The reason for the reported status.

    • description (string) --

      The description of the application.

    • engineType (string) --

      The type of the target platform for the application.

    • environmentId (string) --

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

    • kmsKeyId (string) --

      The identifier of a customer managed key.

    • lastStartTime (datetime) --

      The timestamp when you last started the application. Null until the application runs for the first time.

    • latestVersion (dict) --

      The latest version of the application.

      • applicationVersion (integer) --

        The application version.

      • creationTime (datetime) --

        The timestamp when the application version was created.

      • status (string) --

        The status of the application.

      • statusReason (string) --

        The reason for the reported status.

    • listenerArns (list) --

      The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.

      • (string) --
    • listenerPorts (list) --

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

      • (integer) --
    • loadBalancerDnsName (string) --

      The public DNS name of the load balancer created in your Amazon Web Services account.

    • logGroups (list) --

      The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.

      • (dict) --

        A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.

        • logGroupName (string) --

          The name of the log group.

        • logType (string) --

          The type of log.

    • name (string) --

      The unique identifier of the application.

    • status (string) --

      The status of the application.

    • statusReason (string) --

      The reason for the reported status.

    • tags (dict) --

      A list of tags associated with the application.

      • (string) --
        • (string) --
    • targetGroupArns (list) --

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

      • (string) --

Exceptions

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