:doc:`RTBFabric <../../rtbfabric>` / Client / create_outbound_external_link

*****************************
create_outbound_external_link
*****************************



.. py:method:: RTBFabric.Client.create_outbound_external_link(**kwargs)

  

  Creates an outbound external link.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rtbfabric-2023-05-15/CreateOutboundExternalLink>`_  


  **Request Syntax**
  ::

    response = client.create_outbound_external_link(
        clientToken='string',
        gatewayId='string',
        attributes={
            'responderErrorMasking': [
                {
                    'httpCode': 'string',
                    'action': 'NO_BID'|'PASSTHROUGH',
                    'loggingTypes': [
                        'NONE'|'METRIC'|'RESPONSE',
                    ],
                    'responseLoggingPercentage': ...
                },
            ],
            'customerProvidedId': 'string'
        },
        publicEndpoint='string',
        logSettings={
            'applicationLogs': {
                'sampling': {
                    'errorLog': 123.0,
                    'filterLog': 123.0
                }
            }
        },
        tags={
            'string': 'string'
        }
    )
    
  :type clientToken: string
  :param clientToken: **[REQUIRED]** 

    The unique client token.

    This field is autopopulated if not provided.

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

    The unique identifier of the gateway.

    

  
  :type attributes: dict
  :param attributes: 

    Describes the attributes of a link.

    

  
    - **responderErrorMasking** *(list) --* 

      Describes the masking for HTTP error codes.

      

    
      - *(dict) --* 

        Describes the masking for HTTP error codes.

        

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

          The HTTP error code.

          

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

          The action for the error..

          

        
        - **loggingTypes** *(list) --* **[REQUIRED]** 

          The error log type.

          

        
          - *(string) --* 

          
      
        - **responseLoggingPercentage** *(float) --* 

          The percentage of response logging.

          

        
      
  
    - **customerProvidedId** *(string) --* 

      The customer-provided unique identifier of the link.

      

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

    The public endpoint of the link.

    

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

    Describes the settings for a link log.

    

  
    - **applicationLogs** *(dict) --* **[REQUIRED]** 

      Describes the configuration of a link application log.

      

    
      - **sampling** *(dict) --* **[REQUIRED]** 

        Describes a link application log sample.

        

      
        - **errorLog** *(float) --* **[REQUIRED]** 

          An error log entry.

          

        
        - **filterLog** *(float) --* **[REQUIRED]** 

          A filter log entry.

          

        
      
    
  
  :type tags: dict
  :param tags: 

    A map of the key-value pairs of the tag or tags to assign to the resource.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'gatewayId': 'string',
          'linkId': 'string',
          'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **gatewayId** *(string) --* 

        The unique identifier of the gateway.

        
      

      - **linkId** *(string) --* 

        The unique identifier of the link.

        
      

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

        The status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`RTBFabric.Client.exceptions.ServiceQuotaExceededException`

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

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

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

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

  
  *   :py:class:`RTBFabric.Client.exceptions.ValidationException`

  