:doc:`mgn <../../mgn>` / Client / get_launch_configuration

************************
get_launch_configuration
************************



.. py:method:: mgn.Client.get_launch_configuration(**kwargs)

  

  Lists all LaunchConfigurations available, filtered by Source Server IDs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/GetLaunchConfiguration>`_  


  **Request Syntax**
  ::

    response = client.get_launch_configuration(
        sourceServerID='string',
        accountID='string'
    )
    
  :type sourceServerID: string
  :param sourceServerID: **[REQUIRED]** 

    Request to get Launch Configuration information by Source Server ID.

    

  
  :type accountID: string
  :param accountID: 

    Request to get Launch Configuration information by Account ID.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'sourceServerID': 'string',
          'name': 'string',
          'ec2LaunchTemplateID': 'string',
          'launchDisposition': 'STOPPED'|'STARTED',
          'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
          'copyPrivateIp': True|False,
          'copyTags': True|False,
          'licensing': {
              'osByol': True|False
          },
          'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
          'postLaunchActions': {
              'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
              's3LogBucket': 'string',
              's3OutputKeyPrefix': 'string',
              'cloudWatchLogGroupName': 'string',
              'ssmDocuments': [
                  {
                      'actionName': 'string',
                      'ssmDocumentName': 'string',
                      'timeoutSeconds': 123,
                      'mustSucceedForCutover': True|False,
                      'parameters': {
                          'string': [
                              {
                                  'parameterType': 'STRING'|'SECURE_STRING',
                                  'parameterName': 'string'
                              },
                          ]
                      },
                      'externalParameters': {
                          'string': {
                              'dynamicPath': 'string'
                          }
                      }
                  },
              ]
          },
          'enableMapAutoTagging': True|False,
          'mapAutoTaggingMpeID': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **sourceServerID** *(string) --* 

        Launch configuration Source Server ID.

        
      

      - **name** *(string) --* 

        Launch configuration name.

        
      

      - **ec2LaunchTemplateID** *(string) --* 

        Launch configuration EC2 Launch template ID.

        
      

      - **launchDisposition** *(string) --* 

        Launch disposition for launch configuration.

        
      

      - **targetInstanceTypeRightSizingMethod** *(string) --* 

        Launch configuration Target instance type right sizing method.

        
      

      - **copyPrivateIp** *(boolean) --* 

        Copy Private IP during Launch Configuration.

        
      

      - **copyTags** *(boolean) --* 

        Copy Tags during Launch Configuration.

        
      

      - **licensing** *(dict) --* 

        Launch configuration OS licensing.

        
        

        - **osByol** *(boolean) --* 

          Configure BYOL OS licensing.

          
    
      

      - **bootMode** *(string) --* 

        Launch configuration boot mode.

        
      

      - **postLaunchActions** *(dict) --* 

        Post Launch Actions to executed on the Test or Cutover instance.

        
        

        - **deployment** *(string) --* 

          Deployment type in which AWS Systems Manager Documents will be executed.

          
        

        - **s3LogBucket** *(string) --* 

          AWS Systems Manager Command's logs S3 log bucket.

          
        

        - **s3OutputKeyPrefix** *(string) --* 

          AWS Systems Manager Command's logs S3 output key prefix.

          
        

        - **cloudWatchLogGroupName** *(string) --* 

          AWS Systems Manager Command's CloudWatch log group name.

          
        

        - **ssmDocuments** *(list) --* 

          AWS Systems Manager Documents.

          
          

          - *(dict) --* 

            AWS Systems Manager Document.

            
            

            - **actionName** *(string) --* 

              User-friendly name for the AWS Systems Manager Document.

              
            

            - **ssmDocumentName** *(string) --* 

              AWS Systems Manager Document name or full ARN.

              
            

            - **timeoutSeconds** *(integer) --* 

              AWS Systems Manager Document timeout seconds.

              
            

            - **mustSucceedForCutover** *(boolean) --* 

              If true, Cutover will not be enabled if the document has failed.

              
            

            - **parameters** *(dict) --* 

              AWS Systems Manager Document parameters.

              
              

              - *(string) --* 
                

                - *(list) --* 
                  

                  - *(dict) --* 

                    AWS Systems Manager Parameter Store parameter.

                    
                    

                    - **parameterType** *(string) --* 

                      AWS Systems Manager Parameter Store parameter type.

                      
                    

                    - **parameterName** *(string) --* 

                      AWS Systems Manager Parameter Store parameter name.

                      
                
              
          
        
            

            - **externalParameters** *(dict) --* 

              AWS Systems Manager Document external parameters.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  AWS Systems Manager Document external parameter.

                  .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``dynamicPath``.     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'}


                
                  

                  - **dynamicPath** *(string) --* 

                    AWS Systems Manager Document external parameters dynamic path.

                    
              
          
        
        
      
    
      

      - **enableMapAutoTagging** *(boolean) --* 

        Enable map auto tagging.

        
      

      - **mapAutoTaggingMpeID** *(string) --* 

        Map auto tagging MPE ID.

        
  
  **Exceptions**
  
  *   :py:class:`mgn.Client.exceptions.UninitializedAccountException`

  
  *   :py:class:`mgn.Client.exceptions.ResourceNotFoundException`

  