create_outbound_external_link ¶

def create_outbound_external_link(
    self,
    client_token: str,
    gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId",
    public_endpoint: "capo_rtbfabric.types.url.URL",
    log_settings: "capo_rtbfabric.types.link_log_settings.LinkLogSettings",
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
    attributes: Optional[
        "capo_rtbfabric.types.link_attributes.LinkAttributes"
    ] = None,
    tags: Optional["capo_rtbfabric.types.tags_map.TagsMap"] = None,
) -> "capo_rtbfabric.types.create_outbound_external_link_response.CreateOutboundExternalLinkResponse":
    """<p>Creates an outbound external link.</p>

    Args:
        client_token: <p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>clientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>
        gateway_id: <p>The unique identifier of the gateway.</p>
        attributes: <p>Attributes of the link.</p>
        public_endpoint: <p>The public endpoint of the link.</p>
        log_settings: <p>Settings for the application logs.</p>
        tags: <p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>

    Raises:
        capo_rtbfabric.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
        capo_rtbfabric.errors.conflict_exception.ConflictException: <p>The request could not be completed because of a conflict in the current state of the resource.</p>
        capo_rtbfabric.errors.internal_server_exception.InternalServerException: <p>The request could not be completed because of an internal server error. Try your call again.</p>
        capo_rtbfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request could not be completed because the resource does not exist.</p>
        capo_rtbfabric.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request could not be completed because you exceeded a service quota.</p>
        capo_rtbfabric.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_rtbfabric.errors.validation_exception.ValidationException: <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
        capo_rtbfabric.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create an outbound external link
        Create an outbound external link for a requester gateway to connect to external public responder endpoints

        >>> client.create_outbound_external_link(gateway_id='rtb-gw-12345678', public_endpoint='https://external-responder.example.com', client_token='12345678-1234-1234-1234-123456789012', log_settings={'applicationLogs': {'sampling': {'errorLog': 100.0, 'filterLog': 0.0}}})
    """

    def _handler(
        req: "OperationRequest[capo_rtbfabric.types.create_outbound_external_link_request.CreateOutboundExternalLinkRequest]",
    ) -> OperationResponse[
        "capo_rtbfabric.types.create_outbound_external_link_response.CreateOutboundExternalLinkResponse"
    ]:
        import capo_rtbfabric._operations.rtb_fabric.create_outbound_external_link

        output, http_response = (
            capo_rtbfabric._operations.rtb_fabric.create_outbound_external_link.create_outbound_external_link(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateOutboundExternalLink")
    )
    input_: capo_rtbfabric.types.create_outbound_external_link_request.CreateOutboundExternalLinkRequest = {
        "client_token": client_token,
        "gateway_id": gateway_id,
        "public_endpoint": public_endpoint,
        "log_settings": log_settings,
    }
    if attributes is not None:
        input_["attributes"] = attributes
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output