get_app_launch_configuration¶

SMS.Client.get_app_launch_configuration(**kwargs)¶

Retrieves the application launch configuration associated with the specified application.

Request Syntax

response = client.get_app_launch_configuration(
    appId='string'
)

Parameters

appId (string) -- The ID of the application.

Return type

dict

Returns

Response Syntax

{
    'appId': 'string',
    'roleName': 'string',
    'autoLaunch': True|False,
    'serverGroupLaunchConfigurations': [
        {
            'serverGroupId': 'string',
            'launchOrder': 123,
            'serverLaunchConfigurations': [
                {
                    'server': {
                        'serverId': 'string',
                        'serverType': 'VIRTUAL_MACHINE',
                        'vmServer': {
                            'vmServerAddress': {
                                'vmManagerId': 'string',
                                'vmId': 'string'
                            },
                            'vmName': 'string',
                            'vmManagerName': 'string',
                            'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
                            'vmPath': 'string'
                        },
                        'replicationJobId': 'string',
                        'replicationJobTerminated': True|False
                    },
                    'logicalId': 'string',
                    'vpc': 'string',
                    'subnet': 'string',
                    'securityGroup': 'string',
                    'ec2KeyName': 'string',
                    'userData': {
                        's3Location': {
                            'bucket': 'string',
                            'key': 'string'
                        }
                    },
                    'instanceType': 'string',
                    'associatePublicIpAddress': True|False,
                    'iamInstanceProfileName': 'string',
                    'configureScript': {
                        'bucket': 'string',
                        'key': 'string'
                    },
                    'configureScriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- appId (string) --
  The ID of the application.
- roleName (string) --
  The name of the service role in the customer's account that CloudFormation uses to launch the application.
- autoLaunch (boolean) --
  Indicates whether the application is configured to launch automatically after replication is complete.
- serverGroupLaunchConfigurations (list) --
  The launch configurations for server groups in this application.
  - (dict) --
    Launch configuration for a server group.
    - serverGroupId (string) --
      The ID of the server group with which the launch configuration is associated.
    - launchOrder (integer) --
      The launch order of servers in the server group.
    - serverLaunchConfigurations (list) --
      The launch configuration for servers in the server group.
      - (dict) --
        Launch configuration for a server.
        
        server (dict) --
        The ID of the server with which the launch configuration is associated.
        
        serverId (string) --
        The ID of the server.
        
        serverType (string) --
        The type of server.
        
        vmServer (dict) --
        Information about the VM server.
        
        vmServerAddress (dict) --
        The VM server location.
        
        vmManagerId (string) --
        The ID of the VM manager.
        
        vmId (string) --
        The ID of the VM.
        
        vmName (string) --
        The name of the VM.
        
        vmManagerName (string) --
        The name of the VM manager.
        
        vmManagerType (string) --
        The type of VM management product.
        
        vmPath (string) --
        The VM folder path in the vCenter Server virtual machine inventory tree.
        
        replicationJobId (string) --
        The ID of the replication job.
        
        replicationJobTerminated (boolean) --
        Indicates whether the replication job is deleted or failed.
        
        logicalId (string) --
        The logical ID of the server in the CloudFormation template.
        
        vpc (string) --
        The ID of the VPC into which the server should be launched.
        
        subnet (string) --
        The ID of the subnet the server should be launched into.
        
        securityGroup (string) --
        The ID of the security group that applies to the launched server.
        
        ec2KeyName (string) --
        The name of the Amazon EC2 SSH key to be used for connecting to the launched server.
        
        userData (dict) --
        Location of the user-data script to be executed when launching the server.
        
        s3Location (dict) --
        Amazon S3 location of the user-data script.
        
        bucket (string) --
        The Amazon S3 bucket name.
        
        key (string) --
        The Amazon S3 bucket key.
        
        instanceType (string) --
        The instance type to use when launching the server.
        
        associatePublicIpAddress (boolean) --
        Indicates whether a publicly accessible IP address is created when launching the server.
        
        iamInstanceProfileName (string) --
        The name of the IAM instance profile.
        
        configureScript (dict) --
        Location of an Amazon S3 object.
        
        bucket (string) --
        The Amazon S3 bucket name.
        
        key (string) --
        The Amazon S3 bucket key.
        
        configureScriptType (string) --
        The type of configuration script.

Exceptions

SMS.Client.exceptions.UnauthorizedOperationException
SMS.Client.exceptions.InvalidParameterException
SMS.Client.exceptions.MissingRequiredParameterException
SMS.Client.exceptions.InternalError
SMS.Client.exceptions.OperationNotPermittedException

Table Of Contents

get_app_launch_configuration¶