:doc:`NetworkManager <../../networkmanager>` / Client / create_link

***********
create_link
***********



.. py:method:: NetworkManager.Client.create_link(**kwargs)

  

  Creates a new link for a specified site.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/CreateLink>`_  


  **Request Syntax**
  ::

    response = client.create_link(
        GlobalNetworkId='string',
        Description='string',
        Type='string',
        Bandwidth={
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        Provider='string',
        SiteId='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type GlobalNetworkId: string
  :param GlobalNetworkId: **[REQUIRED]** 

    The ID of the global network.

    

  
  :type Description: string
  :param Description: 

    A description of the link.

     

    Constraints: Maximum length of 256 characters.

    

  
  :type Type: string
  :param Type: 

    The type of the link.

     

    Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

    

  
  :type Bandwidth: dict
  :param Bandwidth: **[REQUIRED]** 

    The upload speed and download speed in Mbps.

    

  
    - **UploadSpeed** *(integer) --* 

      Upload speed in Mbps.

      

    
    - **DownloadSpeed** *(integer) --* 

      Download speed in Mbps.

      

    
  
  :type Provider: string
  :param Provider: 

    The provider of the link.

     

    Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

    

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

    The ID of the site.

    

  
  :type Tags: list
  :param Tags: 

    The tags to apply to the resource during creation.

    

  
    - *(dict) --* 

      Describes a tag.

      

    
      - **Key** *(string) --* 

        The tag key.

         

        Constraints: Maximum length of 128 characters.

        

      
      - **Value** *(string) --* 

        The tag value.

         

        Constraints: Maximum length of 256 characters.

        

      
    

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

    
    ::

      {
          'Link': {
              'LinkId': 'string',
              'LinkArn': 'string',
              'GlobalNetworkId': 'string',
              'SiteId': 'string',
              'Description': 'string',
              'Type': 'string',
              'Bandwidth': {
                  'UploadSpeed': 123,
                  'DownloadSpeed': 123
              },
              'Provider': 'string',
              'CreatedAt': datetime(2015, 1, 1),
              'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
              'Tags': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Link** *(dict) --* 

        Information about the link.

        
        

        - **LinkId** *(string) --* 

          The ID of the link.

          
        

        - **LinkArn** *(string) --* 

          The Amazon Resource Name (ARN) of the link.

          
        

        - **GlobalNetworkId** *(string) --* 

          The ID of the global network.

          
        

        - **SiteId** *(string) --* 

          The ID of the site.

          
        

        - **Description** *(string) --* 

          The description of the link.

          
        

        - **Type** *(string) --* 

          The type of the link.

          
        

        - **Bandwidth** *(dict) --* 

          The bandwidth for the link.

          
          

          - **UploadSpeed** *(integer) --* 

            Upload speed in Mbps.

            
          

          - **DownloadSpeed** *(integer) --* 

            Download speed in Mbps.

            
      
        

        - **Provider** *(string) --* 

          The provider of the link.

          
        

        - **CreatedAt** *(datetime) --* 

          The date and time that the link was created.

          
        

        - **State** *(string) --* 

          The state of the link.

          
        

        - **Tags** *(list) --* 

          The tags for the link.

          
          

          - *(dict) --* 

            Describes a tag.

            
            

            - **Key** *(string) --* 

              The tag key.

               

              Constraints: Maximum length of 128 characters.

              
            

            - **Value** *(string) --* 

              The tag value.

               

              Constraints: Maximum length of 256 characters.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`NetworkManager.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ServiceQuotaExceededException`

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

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

  
  *   :py:class:`NetworkManager.Client.exceptions.ConflictException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkManager.Client.exceptions.InternalServerException`

  