:doc:`Lightsail <../../lightsail>` / Client / create_instances

****************
create_instances
****************



.. py:method:: Lightsail.Client.create_instances(**kwargs)

  

  Creates one or more Amazon Lightsail instances.

   

  The ``create instances`` operation supports tag-based access control via request tags. For more information, see the `Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstances>`_  


  **Request Syntax**
  ::

    response = client.create_instances(
        instanceNames=[
            'string',
        ],
        availabilityZone='string',
        customImageName='string',
        blueprintId='string',
        bundleId='string',
        userData='string',
        keyPairName='string',
        tags=[
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        addOns=[
            {
                'addOnType': 'AutoSnapshot'|'StopInstanceOnIdle',
                'autoSnapshotAddOnRequest': {
                    'snapshotTimeOfDay': 'string'
                },
                'stopInstanceOnIdleRequest': {
                    'threshold': 'string',
                    'duration': 'string'
                }
            },
        ],
        ipAddressType='dualstack'|'ipv4'|'ipv6'
    )
    
  :type instanceNames: list
  :param instanceNames: **[REQUIRED]** 

    The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ``["MyFirstInstance","MySecondInstance"]``

    

  
    - *(string) --* 

    

  :type availabilityZone: string
  :param availabilityZone: **[REQUIRED]** 

    The Availability Zone in which to create your instance. Use the following format: ``us-east-2a`` (case sensitive). You can get a list of Availability Zones by using the `get regions <http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html>`__ operation. Be sure to add the ``include Availability Zones`` parameter to your request.

    

  
  :type customImageName: string
  :param customImageName: 

    (Discontinued) The name for your custom image.

     

    .. note::

      

      In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

      

    

  
  :type blueprintId: string
  :param blueprintId: **[REQUIRED]** 

    The ID for a virtual private server image ( ``app_wordpress_x_x`` or ``app_lamp_x_x``). Use the ``get blueprints`` operation to return a list of available images (or *blueprints*).

     

    .. note::

      

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

      

    

  
  :type bundleId: string
  :param bundleId: **[REQUIRED]** 

    The bundle of specification information for your virtual private server (or *instance*), including the pricing plan ( ``medium_x_x``).

    

  
  :type userData: string
  :param userData: 

    A launch script you can create that configures a server with additional user data. For example, you might want to run ``apt-get -y update``.

     

    .. note::

      

      Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use ``yum``, Debian and Ubuntu use ``apt-get``, and FreeBSD uses ``pkg``. For a complete list, see the `Amazon Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image>`__.

      

    

  
  :type keyPairName: string
  :param keyPairName: 

    The name of your key pair.

    

  
  :type tags: list
  :param tags: 

    The tag keys and optional values to add to the resource during create.

     

    Use the ``TagResource`` action to tag a resource after it's created.

    

  
    - *(dict) --* 

      Describes a tag key and optional value assigned to an Amazon Lightsail resource.

       

      For more information about tags in Lightsail, see the `Amazon Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags>`__.

      

    
      - **key** *(string) --* 

        The key of the tag.

         

        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        

      
      - **value** *(string) --* 

        The value of the tag.

         

        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        

      
    

  :type addOns: list
  :param addOns: 

    An array of objects representing the add-ons to enable for the new instance.

    

  
    - *(dict) --* 

      Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

       

      .. note::

        

        An additional cost may be associated with enabling add-ons. For more information, see the `Lightsail pricing page <https://aws.amazon.com/lightsail/pricing/>`__.

        

      

    
      - **addOnType** *(string) --* **[REQUIRED]** 

        The add-on type.

        

      
      - **autoSnapshotAddOnRequest** *(dict) --* 

        An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

        

      
        - **snapshotTimeOfDay** *(string) --* 

          The daily time when an automatic snapshot will be created.

           

          Constraints:

           

          
          * Must be in ``HH:00`` format, and in an hourly increment.
           
          * Specified in Coordinated Universal Time (UTC).
           
          * The snapshot will be automatically created between the time specified and up to 45 minutes after.
          

          

        
      
      - **stopInstanceOnIdleRequest** *(dict) --* 

        An object that represents additional parameters when enabling or modifying the ``StopInstanceOnIdle`` add-on.

         

        .. warning::

           

          This object only applies to Lightsail for Research resources.

          

        

      
        - **threshold** *(string) --* 

          The value to compare with the duration.

          

        
        - **duration** *(string) --* 

          The amount of idle time in minutes after which your virtual computer will automatically stop.

          

        
      
    

  :type ipAddressType: string
  :param ipAddressType: 

    The IP address type for the instance.

     

    The possible values are ``ipv4`` for IPv4 only, ``ipv6`` for IPv6 only, and ``dualstack`` for IPv4 and IPv6.

     

    The default value is ``dualstack``.

    

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

    
    ::

      {
          'operations': [
              {
                  'id': 'string',
                  'resourceName': 'string',
                  'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
                  'createdAt': datetime(2015, 1, 1),
                  'location': {
                      'availabilityZone': 'string',
                      'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'|'ap-southeast-3'
                  },
                  'isTerminal': True|False,
                  'operationDetails': 'string',
                  'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
                  'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
                  'statusChangedAt': datetime(2015, 1, 1),
                  'errorCode': 'string',
                  'errorDetails': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **operations** *(list) --* 

        An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

        
        

        - *(dict) --* 

          Describes the API operation.

          
          

          - **id** *(string) --* 

            The ID of the operation.

            
          

          - **resourceName** *(string) --* 

            The resource name.

            
          

          - **resourceType** *(string) --* 

            The resource type.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp when the operation was initialized ( ``1479816991.349``).

            
          

          - **location** *(dict) --* 

            The Amazon Web Services Region and Availability Zone.

            
            

            - **availabilityZone** *(string) --* 

              The Availability Zone. Follows the format ``us-east-2a`` (case-sensitive).

              
            

            - **regionName** *(string) --* 

              The Amazon Web Services Region name.

              
        
          

          - **isTerminal** *(boolean) --* 

            A Boolean value indicating whether the operation is terminal.

            
          

          - **operationDetails** *(string) --* 

            Details about the operation ( ``Debian-1GB-Ohio-1``).

            
          

          - **operationType** *(string) --* 

            The type of operation.

            
          

          - **status** *(string) --* 

            The status of the operation.

            
          

          - **statusChangedAt** *(datetime) --* 

            The timestamp when the status was changed ( ``1479816991.349``).

            
          

          - **errorCode** *(string) --* 

            The error code.

            
          

          - **errorDetails** *(string) --* 

            The error details.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.OperationFailureException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccountSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  