AWS API Changes

2025/11/11 - RTBFabric - 4 updated api methods

Changes Added LogSettings and LinkAttribute fields to external links

CreateInboundExternalLink (updated)

Link ¶
Changes (request)

{'logSettings': {'applicationLogs': {'sampling': {'errorLog': 'double',
                                                  'filterLog': 'double'}}}}

Creates an inbound external link.

See also: AWS API Documentation

Request Syntax

client.create_inbound_external_link(
    clientToken='string',
    gatewayId='string',
    attributes={
        'responderErrorMasking': [
            {
                'httpCode': 'string',
                'action': 'NO_BID'|'PASSTHROUGH',
                'loggingTypes': [
                    'NONE'|'METRIC'|'RESPONSE',
                ],
                'responseLoggingPercentage': ...
            },
        ],
        'customerProvidedId': '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:

Attributes of the 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 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',
    'domainName': 'string'
}

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.
- domainName (string) --
  
  The domain name.

CreateOutboundExternalLink (updated)

Link ¶
Changes (request)

{'attributes': {'customerProvidedId': 'string',
                'responderErrorMasking': [{'action': 'NO_BID | PASSTHROUGH',
                                           'httpCode': 'string',
                                           'loggingTypes': ['NONE | METRIC | '
                                                            'RESPONSE'],
                                           'responseLoggingPercentage': 'float'}]},
 'logSettings': {'applicationLogs': {'sampling': {'errorLog': 'double',
                                                  'filterLog': 'double'}}}}

Creates an outbound external link.

See also: AWS API Documentation

Request Syntax

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.

GetInboundExternalLink (updated)

Link ¶
Changes (response)

{'logSettings': {'applicationLogs': {'sampling': {'errorLog': 'double',
                                                  'filterLog': 'double'}}}}

Retrieves information about an inbound external link.

See also: AWS API Documentation

Request Syntax

client.get_inbound_external_link(
    gatewayId='string',
    linkId='string'
)

type gatewayId:

string

param gatewayId:

[REQUIRED]

The unique identifier of the gateway.

type linkId:

string

param linkId:

[REQUIRED]

The unique identifier of the link.

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',
    'domainName': 'string',
    'flowModules': [
        {
            'version': 'string',
            'name': 'string',
            'dependsOn': [
                'string',
            ],
            'moduleParameters': {
                'noBid': {
                    'reason': 'string',
                    'reasonCode': 123,
                    'passThroughPercentage': ...
                },
                'openRtbAttribute': {
                    'filterType': 'INCLUDE'|'EXCLUDE',
                    'filterConfiguration': [
                        {
                            'criteria': [
                                {
                                    'path': 'string',
                                    'values': [
                                        'string',
                                    ]
                                },
                            ]
                        },
                    ],
                    'action': {
                        'noBid': {
                            'noBidReasonCode': 123
                        },
                        'headerTag': {
                            'name': 'string',
                            'value': 'string'
                        }
                    },
                    'holdbackPercentage': ...
                },
                'rateLimiter': {
                    'tps': ...
                }
            }
        },
    ],
    'pendingFlowModules': [
        {
            'version': 'string',
            'name': 'string',
            'dependsOn': [
                'string',
            ],
            'moduleParameters': {
                'noBid': {
                    'reason': 'string',
                    'reasonCode': 123,
                    'passThroughPercentage': ...
                },
                'openRtbAttribute': {
                    'filterType': 'INCLUDE'|'EXCLUDE',
                    'filterConfiguration': [
                        {
                            'criteria': [
                                {
                                    'path': 'string',
                                    'values': [
                                        'string',
                                    ]
                                },
                            ]
                        },
                    ],
                    'action': {
                        'noBid': {
                            'noBidReasonCode': 123
                        },
                        'headerTag': {
                            'name': 'string',
                            'value': 'string'
                        }
                    },
                    'holdbackPercentage': ...
                },
                'rateLimiter': {
                    'tps': ...
                }
            }
        },
    ],
    'attributes': {
        'responderErrorMasking': [
            {
                'httpCode': 'string',
                'action': 'NO_BID'|'PASSTHROUGH',
                'loggingTypes': [
                    'NONE'|'METRIC'|'RESPONSE',
                ],
                'responseLoggingPercentage': ...
            },
        ],
        'customerProvidedId': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'logSettings': {
        'applicationLogs': {
            'sampling': {
                'errorLog': 123.0,
                'filterLog': 123.0
            }
        }
    }
}

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.
- domainName (string) --
  
  The domain name.
- flowModules (list) --
  
  The configuration of flow modules.
  - (dict) --
    
    Describes the configuration of a module.
    - version (string) --
      
      The version of the module.
    - name (string) --
      
      The name of the module.
    - dependsOn (list) --
      
      The dependencies of the module.
      - (string) --
    - moduleParameters (dict) --
      
      Describes the parameters of a module.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: noBid, openRtbAttribute, rateLimiter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - noBid (dict) --
        
        Describes the parameters of a no bid module.
        
        reason (string) --
        
        The reason description.
        
        reasonCode (integer) --
        
        The reason code.
        
        passThroughPercentage (float) --
        
        The pass through percentage.
      - openRtbAttribute (dict) --
        
        Describes the parameters of an open RTB attribute module.
        
        filterType (string) --
        
        The filter type.
        
        filterConfiguration (list) --
        
        Describes the configuration of a filter.
        
        (dict) --
        
        Describes the configuration of a filter.
        
        criteria (list) --
        
        Describes the criteria for a filter.
        
        (dict) --
        
        Describes the criteria for a filter.
        
        path (string) --
        
        The path to filter.
        
        values (list) --
        
        The value to filter.
        
        (string) --
        
        action (dict) --
        
        Describes a bid action.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: noBid, headerTag. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        noBid (dict) --
        
        Describes a no bid action.
        
        noBidReasonCode (integer) --
        
        The reason code for the no bid action.
        
        headerTag (dict) --
        
        Describes the header tag for a bid action.
        
        name (string) --
        
        The name of the bid action.
        
        value (string) --
        
        The value of the bid action.
        
        holdbackPercentage (float) --
        
        The hold back percentage.
      - rateLimiter (dict) --
        
        Describes the parameters of a rate limit.
        
        tps (float) --
        
        The transactions per second rate limit.
- pendingFlowModules (list) --
  
  The configuration of pending flow modules.
  - (dict) --
    
    Describes the configuration of a module.
    - version (string) --
      
      The version of the module.
    - name (string) --
      
      The name of the module.
    - dependsOn (list) --
      
      The dependencies of the module.
      - (string) --
    - moduleParameters (dict) --
      
      Describes the parameters of a module.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: noBid, openRtbAttribute, rateLimiter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - noBid (dict) --
        
        Describes the parameters of a no bid module.
        
        reason (string) --
        
        The reason description.
        
        reasonCode (integer) --
        
        The reason code.
        
        passThroughPercentage (float) --
        
        The pass through percentage.
      - openRtbAttribute (dict) --
        
        Describes the parameters of an open RTB attribute module.
        
        filterType (string) --
        
        The filter type.
        
        filterConfiguration (list) --
        
        Describes the configuration of a filter.
        
        (dict) --
        
        Describes the configuration of a filter.
        
        criteria (list) --
        
        Describes the criteria for a filter.
        
        (dict) --
        
        Describes the criteria for a filter.
        
        path (string) --
        
        The path to filter.
        
        values (list) --
        
        The value to filter.
        
        (string) --
        
        action (dict) --
        
        Describes a bid action.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: noBid, headerTag. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        noBid (dict) --
        
        Describes a no bid action.
        
        noBidReasonCode (integer) --
        
        The reason code for the no bid action.
        
        headerTag (dict) --
        
        Describes the header tag for a bid action.
        
        name (string) --
        
        The name of the bid action.
        
        value (string) --
        
        The value of the bid action.
        
        holdbackPercentage (float) --
        
        The hold back percentage.
      - rateLimiter (dict) --
        
        Describes the parameters of a rate limit.
        
        tps (float) --
        
        The transactions per second rate limit.
- attributes (dict) --
  
  Attributes of the link.
  - responderErrorMasking (list) --
    
    Describes the masking for HTTP error codes.
    - (dict) --
      
      Describes the masking for HTTP error codes.
      - httpCode (string) --
        
        The HTTP error code.
      - action (string) --
        
        The action for the error..
      - loggingTypes (list) --
        
        The error log type.
        
        (string) --
      - responseLoggingPercentage (float) --
        
        The percentage of response logging.
  - customerProvidedId (string) --
    
    The customer-provided unique identifier of the link.
- createdAt (datetime) --
  
  The timestamp of when the inbound external link was created.
- updatedAt (datetime) --
  
  The timestamp of when the inbound external link was updated.
- tags (dict) --
  
  A map of the key-value pairs for the tag or tags assigned to the specified resource.
  - (string) --
    - (string) --
- logSettings (dict) --
  
  Describes the settings for a link log.
  - applicationLogs (dict) --
    
    Describes the configuration of a link application log.
    - sampling (dict) --
      
      Describes a link application log sample.
      - errorLog (float) --
        
        An error log entry.
      - filterLog (float) --
        
        A filter log entry.

GetOutboundExternalLink (updated)

Link ¶
Changes (response)

{'logSettings': {'applicationLogs': {'sampling': {'errorLog': 'double',
                                                  'filterLog': 'double'}}}}

Retrieves information about an outbound external link.

See also: AWS API Documentation

Request Syntax

client.get_outbound_external_link(
    gatewayId='string',
    linkId='string'
)

type gatewayId:

string

param gatewayId:

[REQUIRED]

The unique identifier of the gateway.

type linkId:

string

param linkId:

[REQUIRED]

The unique identifier of the link.

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',
    'publicEndpoint': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'logSettings': {
        'applicationLogs': {
            'sampling': {
                'errorLog': 123.0,
                'filterLog': 123.0
            }
        }
    }
}

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.
- publicEndpoint (string) --
  
  The public endpoint for the link.
- createdAt (datetime) --
  
  The timestamp of when the outbound external link was created.
- updatedAt (datetime) --
  
  The timestamp of when the outbound external link was updated.
- tags (dict) --
  
  A map of the key-value pairs for the tag or tags assigned to the specified resource.
  - (string) --
    - (string) --
- logSettings (dict) --
  
  Describes the settings for a link log.
  - applicationLogs (dict) --
    
    Describes the configuration of a link application log.
    - sampling (dict) --
      
      Describes a link application log sample.
      - errorLog (float) --
        
        An error log entry.
      - filterLog (float) --
        
        A filter log entry.