:doc:`ElasticLoadBalancingv2 <../../elbv2>` / Client / add_listener_certificates

*************************
add_listener_certificates
*************************



.. py:method:: ElasticLoadBalancingv2.Client.add_listener_certificates(**kwargs)

  

  Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

   

  If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

   

  For more information, see `SSL certificates <https://docs.aws.amazon.com/elasticloadbalancing/latest/application/https-listener-certificates.html>`__ in the *Application Load Balancers Guide* or `Server certificates <https://docs.aws.amazon.com/elasticloadbalancing/latest/network/tls-listener-certificates.html>`__ in the *Network Load Balancers Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddListenerCertificates>`_  


  **Request Syntax**
  ::

    response = client.add_listener_certificates(
        ListenerArn='string',
        Certificates=[
            {
                'CertificateArn': 'string',
                'IsDefault': True|False
            },
        ]
    )
    
  :type ListenerArn: string
  :param ListenerArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the listener.

    

  
  :type Certificates: list
  :param Certificates: **[REQUIRED]** 

    The certificate to add. You can specify one certificate per call. Set ``CertificateArn`` to the certificate ARN but do not set ``IsDefault``.

    

  
    - *(dict) --* 

      Information about an SSL server certificate.

      

    
      - **CertificateArn** *(string) --* 

        The Amazon Resource Name (ARN) of the certificate.

        

      
      - **IsDefault** *(boolean) --* 

        Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

        

      
    

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

    
    ::

      {
          'Certificates': [
              {
                  'CertificateArn': 'string',
                  'IsDefault': True|False
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Certificates** *(list) --* 

        Information about the certificates in the certificate list.

        
        

        - *(dict) --* 

          Information about an SSL server certificate.

          
          

          - **CertificateArn** *(string) --* 

            The Amazon Resource Name (ARN) of the certificate.

            
          

          - **IsDefault** *(boolean) --* 

            Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.ListenerNotFoundException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.TooManyCertificatesException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.CertificateNotFoundException`

  