AcceptLink

$result = $client->acceptLink([/* ... */]);
$promise = $client->acceptLinkAsync([/* ... */]);

Accepts a link request between gateways.

When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.

Parameter Syntax

$result = $client->acceptLink([
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH', // REQUIRED
                'httpCode' => '<string>', // REQUIRED
                'loggingTypes' => ['<string>', ...], // REQUIRED
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'logSettings' => [ // REQUIRED
        'applicationLogs' => [ // REQUIRED
            'sampling' => [ // REQUIRED
                'errorLog' => <float>, // REQUIRED
                'filterLog' => <float>, // REQUIRED
            ],
        ],
    ],
    'timeoutInMillis' => <integer>,
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'direction' => 'RESPONSE|REQUEST',
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'peerGatewayId' => '<string>',
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Accept a link request

Accepts a link request from requester gateway

$result = $client->acceptLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => 100,
                'filterLog' => 0,
            ],
        ],
    ],
]);

Result syntax:

[
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'peerGatewayId' => 'rtb-gw-87654321',
    'status' => 'ACCEPTED',
    'updatedAt' => ,
]

AssociateCertificate

$result = $client->associateCertificate([/* ... */]);
$promise = $client->associateCertificateAsync([/* ... */]);

Associates an ACM certificate with a responder gateway.

Parameter Syntax

$result = $client->associateCertificate([
    'acmCertificateArn' => '<string>', // REQUIRED
    'clientToken' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acmCertificateArn' => '<string>',
    'gatewayId' => '<string>',
    'status' => 'PENDING_ASSOCIATION|ASSOCIATED|PENDING_DISASSOCIATION|DISASSOCIATED|FAILED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Associate a certificate with a responder gateway

Associate an ACM certificate with a responder gateway

$result = $client->associateCertificate([
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'clientToken' => '550e8400-e29b-41d4-a716-446655440000',
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_ASSOCIATION',
]

CreateInboundExternalLink

$result = $client->createInboundExternalLink([/* ... */]);
$promise = $client->createInboundExternalLinkAsync([/* ... */]);

Creates an inbound external link.

Parameter Syntax

$result = $client->createInboundExternalLink([
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH', // REQUIRED
                'httpCode' => '<string>', // REQUIRED
                'loggingTypes' => ['<string>', ...], // REQUIRED
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'clientToken' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
    'logSettings' => [ // REQUIRED
        'applicationLogs' => [ // REQUIRED
            'sampling' => [ // REQUIRED
                'errorLog' => <float>, // REQUIRED
                'filterLog' => <float>, // REQUIRED
            ],
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'domainName' => '<string>',
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create an inbound external link

Create an inbound external link for a responder gateway

$result = $client->createInboundExternalLink([
    'clientToken' => 'randomClientToken',
    'gatewayId' => 'rtb-gw-12345678',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => 100,
                'filterLog' => 0,
            ],
        ],
    ],
]);

Result syntax:

[
    'domainName' => 'rtb-gw-12345678.example.com',
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'status' => 'ACTIVE',
]

CreateLink

$result = $client->createLink([/* ... */]);
$promise = $client->createLinkAsync([/* ... */]);

Creates a new link between gateways.

Establishes a connection that allows gateways to communicate and exchange bid requests and responses.

Parameter Syntax

$result = $client->createLink([
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH', // REQUIRED
                'httpCode' => '<string>', // REQUIRED
                'loggingTypes' => ['<string>', ...], // REQUIRED
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'gatewayId' => '<string>', // REQUIRED
    'httpResponderAllowed' => true || false,
    'logSettings' => [ // REQUIRED
        'applicationLogs' => [ // REQUIRED
            'sampling' => [ // REQUIRED
                'errorLog' => <float>, // REQUIRED
                'filterLog' => <float>, // REQUIRED
            ],
        ],
    ],
    'peerGatewayId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'timeoutInMillis' => <integer>,
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'customerProvidedId' => '<string>',
    'direction' => 'RESPONSE|REQUEST',
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'peerGatewayId' => '<string>',
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create a standard link between gateways

Creates a new link between two RTB applications. Requires peerGatewayId to specify the target gateway.

$result = $client->createLink([
    'gatewayId' => 'rtb-gw-12345678',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => 100,
                'filterLog' => 0,
            ],
        ],
    ],
    'peerGatewayId' => 'rtb-gw-87654321',
]);

Result syntax:

[
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'peerGatewayId' => 'rtb-gw-87654321',
    'status' => 'PENDING_REQUEST',
    'updatedAt' => ,
]

CreateLinkRoutingRule

$result = $client->createLinkRoutingRule([/* ... */]);
$promise = $client->createLinkRoutingRuleAsync([/* ... */]);

Creates a routing rule for a link.

Routing rules use priority-based evaluation where lower priority numbers are evaluated first. Each rule specifies conditions that must all match for the rule to apply.

Parameter Syntax

$result = $client->createLinkRoutingRule([
    'clientToken' => '<string>', // REQUIRED
    'conditions' => [ // REQUIRED
        'hostHeader' => '<string>',
        'hostHeaderWildcard' => '<string>',
        'pathExact' => '<string>',
        'pathPrefix' => '<string>',
        'queryStringEquals' => [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        'queryStringExists' => '<string>',
    ],
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'priority' => <integer>, // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'ruleId' => '<string>',
    'status' => 'CREATION_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETION_IN_PROGRESS|DELETED|FAILED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create a link routing rule

Create a routing rule with host header and path prefix conditions

$result = $client->createLinkRoutingRule([
    'clientToken' => '550e8400-e29b-41d4-a716-446655440000',
    'conditions' => [
        'hostHeader' => 'api.customer.com',
        'pathPrefix' => '/openrtb/',
    ],
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'priority' => 10,
]);

Result syntax:

[
    'createdAt' => ,
    'ruleId' => 'rule-abc123def456',
    'status' => 'CREATION_IN_PROGRESS',
]

CreateOutboundExternalLink

$result = $client->createOutboundExternalLink([/* ... */]);
$promise = $client->createOutboundExternalLinkAsync([/* ... */]);

Creates an outbound external link.

Parameter Syntax

$result = $client->createOutboundExternalLink([
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH', // REQUIRED
                'httpCode' => '<string>', // REQUIRED
                'loggingTypes' => ['<string>', ...], // REQUIRED
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'clientToken' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
    'logSettings' => [ // REQUIRED
        'applicationLogs' => [ // REQUIRED
            'sampling' => [ // REQUIRED
                'errorLog' => <float>, // REQUIRED
                'filterLog' => <float>, // REQUIRED
            ],
        ],
    ],
    'publicEndpoint' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result 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',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create an outbound external link

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

$result = $client->createOutboundExternalLink([
    'clientToken' => '12345678-1234-1234-1234-123456789012',
    'gatewayId' => 'rtb-gw-12345678',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => 100,
                'filterLog' => 0,
            ],
        ],
    ],
    'publicEndpoint' => 'https://external-responder.example.com',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'status' => 'ACTIVE',
]

CreateRequesterGateway

$result = $client->createRequesterGateway([/* ... */]);
$promise = $client->createRequesterGatewayAsync([/* ... */]);

Creates a requester gateway.

Parameter Syntax

$result = $client->createRequesterGateway([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'securityGroupIds' => ['<string>', ...], // REQUIRED
    'subnetIds' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'domainName' => '<string>',
    'gatewayId' => '<string>',
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create a requester gateway

Create requester gateway

$result = $client->createRequesterGateway([
    'clientToken' => '12345678-1234-1234-1234-123456789012',
    'description' => 'My requester gateway',
    'securityGroupIds' => [
        'sg-12345678',
    ],
    'subnetIds' => [
        'subnet-12345678',
        'subnet-87654321',
    ],
    'vpcId' => 'vpc-12345678',
]);

Result syntax:

[
    'domainName' => 'rtb-gw-12345678.example.com',
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'ACTIVE',
]

CreateResponderGateway

$result = $client->createResponderGateway([/* ... */]);
$promise = $client->createResponderGatewayAsync([/* ... */]);

Creates a responder gateway.

Parameter Syntax

$result = $client->createResponderGateway([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'domainName' => '<string>',
    'gatewayType' => 'EXTERNAL|INTERNAL',
    'listenerConfig' => [
        'protocols' => ['<string>', ...], // REQUIRED
    ],
    'managedEndpointConfiguration' => [
        'autoScalingGroups' => [
            'autoScalingGroupNames' => ['<string>', ...], // REQUIRED
            'healthCheckConfig' => [
                'healthyThresholdCount' => <integer>,
                'intervalSeconds' => <integer>,
                'path' => '<string>', // REQUIRED
                'port' => <integer>, // REQUIRED
                'protocol' => 'HTTP|HTTPS',
                'statusCodeMatcher' => '<string>',
                'timeoutMs' => <integer>,
                'unhealthyThresholdCount' => <integer>,
            ],
            'roleArn' => '<string>', // REQUIRED
        ],
        'eksEndpoints' => [
            'clusterApiServerCaCertificateChain' => '<string>', // REQUIRED
            'clusterApiServerEndpointUri' => '<string>', // REQUIRED
            'clusterName' => '<string>', // REQUIRED
            'endpointsResourceName' => '<string>', // REQUIRED
            'endpointsResourceNamespace' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
    ],
    'port' => <integer>, // REQUIRED
    'protocol' => 'HTTP|HTTPS', // REQUIRED
    'securityGroupIds' => ['<string>', ...], // REQUIRED
    'subnetIds' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'trustStoreConfiguration' => [
        'certificateAuthorityCertificates' => ['<string>', ...], // REQUIRED
    ],
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'externalInboundEndpoint' => '<string>',
    'gatewayId' => '<string>',
    'listenerConfig' => [
        'protocols' => ['<string>', ...],
    ],
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Create a responder gateway

Create responder gateway

$result = $client->createResponderGateway([
    'clientToken' => '12345678-1234-1234-1234-123456789012',
    'description' => 'My responder gateway',
    'port' => 443,
    'protocol' => 'HTTPS',
    'securityGroupIds' => [
        'sg-12345678',
    ],
    'subnetIds' => [
        'subnet-12345678',
        'subnet-87654321',
    ],
    'vpcId' => 'vpc-12345678',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'ACTIVE',
]

DeleteInboundExternalLink

$result = $client->deleteInboundExternalLink([/* ... */]);
$promise = $client->deleteInboundExternalLinkAsync([/* ... */]);

Deletes an inbound external link.

Parameter Syntax

$result = $client->deleteInboundExternalLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'linkId' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete an inbound external link

Delete an inbound external link

$result = $client->deleteInboundExternalLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'linkId' => 'link-87654321',
    'status' => 'DELETED',
]

DeleteLink

$result = $client->deleteLink([/* ... */]);
$promise = $client->deleteLinkAsync([/* ... */]);

Deletes a link between gateways.

Permanently removes the connection between gateways. This action cannot be undone.

Parameter Syntax

$result = $client->deleteLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'linkId' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete a link

Deletes an existing link

$result = $client->deleteLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'linkId' => 'link-87654321',
    'status' => 'PENDING_DELETION',
]

DeleteLinkRoutingRule

$result = $client->deleteLinkRoutingRule([/* ... */]);
$promise = $client->deleteLinkRoutingRuleAsync([/* ... */]);

Deletes a routing rule from a link.

Parameter Syntax

$result = $client->deleteLinkRoutingRule([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'ruleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ruleId' => '<string>',
    'status' => 'CREATION_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETION_IN_PROGRESS|DELETED|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete a link routing rule

Delete a link routing rule

$result = $client->deleteLinkRoutingRule([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'ruleId' => 'rule-abc123def456',
]);

Result syntax:

[
    'ruleId' => 'rule-abc123def456',
    'status' => 'DELETION_IN_PROGRESS',
]

DeleteOutboundExternalLink

$result = $client->deleteOutboundExternalLink([/* ... */]);
$promise = $client->deleteOutboundExternalLinkAsync([/* ... */]);

Deletes an outbound external link.

Parameter Syntax

$result = $client->deleteOutboundExternalLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'linkId' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete an outbound external link

Delete an outbound external link

$result = $client->deleteOutboundExternalLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'linkId' => 'link-87654321',
    'status' => 'DELETED',
]

DeleteRequesterGateway

$result = $client->deleteRequesterGateway([/* ... */]);
$promise = $client->deleteRequesterGatewayAsync([/* ... */]);

Deletes a requester gateway.

Parameter Syntax

$result = $client->deleteRequesterGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'gatewayId' => '<string>',
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete a requester gateway

Delete requester gateway

$result = $client->deleteRequesterGateway([
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_DELETION',
]

DeleteResponderGateway

$result = $client->deleteResponderGateway([/* ... */]);
$promise = $client->deleteResponderGatewayAsync([/* ... */]);

Deletes a responder gateway.

Parameter Syntax

$result = $client->deleteResponderGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'gatewayId' => '<string>',
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Delete a responder gateway

Delete responder gateway

$result = $client->deleteResponderGateway([
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_DELETION',
]

DisassociateCertificate

$result = $client->disassociateCertificate([/* ... */]);
$promise = $client->disassociateCertificateAsync([/* ... */]);

Removes a certificate association from a responder gateway.

Parameter Syntax

$result = $client->disassociateCertificate([
    'acmCertificateArn' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acmCertificateArn' => '<string>',
    'gatewayId' => '<string>',
    'status' => 'PENDING_ASSOCIATION|ASSOCIATED|PENDING_DISASSOCIATION|DISASSOCIATED|FAILED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Disassociate a certificate from a responder gateway

Remove an ACM certificate association from a responder gateway

$result = $client->disassociateCertificate([
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_DISASSOCIATION',
]

GetCertificateAssociation

$result = $client->getCertificateAssociation([/* ... */]);
$promise = $client->getCertificateAssociationAsync([/* ... */]);

Retrieves the details of a certificate association with a responder gateway.

Parameter Syntax

$result = $client->getCertificateAssociation([
    'acmCertificateArn' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acmCertificateArn' => '<string>',
    'associatedAt' => <DateTime>,
    'gatewayId' => '<string>',
    'status' => 'PENDING_ASSOCIATION|ASSOCIATED|PENDING_DISASSOCIATION|DISASSOCIATED|FAILED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get certificate association details from a responder gateway

Retrieve details of an ACM certificate association with a responder gateway

$result = $client->getCertificateAssociation([
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
    'associatedAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'ASSOCIATED',
    'updatedAt' => ,
]

GetInboundExternalLink

$result = $client->getInboundExternalLink([/* ... */]);
$promise = $client->getInboundExternalLinkAsync([/* ... */]);

Retrieves information about an inbound external link.

Parameter Syntax

$result = $client->getInboundExternalLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'domainName' => '<string>',
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get inbound external link details

Get details of an inbound external link

$result = $client->getInboundExternalLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'createdAt' => ,
    'domainName' => 'rtb-gw-12345678.123456789012.gateway.rtbfabric.us-east-1.amazonaws.com',
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'status' => 'ACTIVE',
    'updatedAt' => ,
]

GetLink

$result = $client->getLink([/* ... */]);
$promise = $client->getLinkAsync([/* ... */]);

Retrieves information about a link between gateways.

Returns detailed information about the link configuration, status, and associated gateways.

Parameter Syntax

$result = $client->getLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'direction' => 'RESPONSE|REQUEST',
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'httpResponderAllowed' => true || false,
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'peerGatewayId' => '<string>',
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'tags' => ['<string>', ...],
    'timeoutInMillis' => <integer>,
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get link details

Retrieves details of a specific link

$result = $client->getLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'peerGatewayId' => 'rtb-gw-87654321',
    'status' => 'ACTIVE',
    'updatedAt' => ,
]

GetLinkRoutingRule

$result = $client->getLinkRoutingRule([/* ... */]);
$promise = $client->getLinkRoutingRuleAsync([/* ... */]);

Retrieves the details of a routing rule for a link.

Parameter Syntax

$result = $client->getLinkRoutingRule([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'ruleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'conditions' => [
        'hostHeader' => '<string>',
        'hostHeaderWildcard' => '<string>',
        'pathExact' => '<string>',
        'pathPrefix' => '<string>',
        'queryStringEquals' => [
            'key' => '<string>',
            'value' => '<string>',
        ],
        'queryStringExists' => '<string>',
    ],
    'createdAt' => <DateTime>,
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'priority' => <integer>,
    'ruleId' => '<string>',
    'status' => 'CREATION_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETION_IN_PROGRESS|DELETED|FAILED',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get link routing rule details

Get details of a link routing rule

$result = $client->getLinkRoutingRule([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'ruleId' => 'rule-abc123def456',
]);

Result syntax:

[
    'conditions' => [
        'hostHeader' => 'api.customer.com',
        'pathPrefix' => '/openrtb/',
    ],
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'priority' => 10,
    'ruleId' => 'rule-abc123def456',
    'status' => 'ACTIVE',
    'updatedAt' => ,
]

GetOutboundExternalLink

$result = $client->getOutboundExternalLink([/* ... */]);
$promise = $client->getOutboundExternalLinkAsync([/* ... */]);

Retrieves information about an outbound external link.

Parameter Syntax

$result = $client->getOutboundExternalLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'publicEndpoint' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get outbound external link details

Get details of a specific outbound external link

$result = $client->getOutboundExternalLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'publicEndpoint' => 'https://external-responder.example.com',
    'status' => 'ACTIVE',
    'updatedAt' => ,
]

GetRequesterGateway

$result = $client->getRequesterGateway([/* ... */]);
$promise = $client->getRequesterGatewayAsync([/* ... */]);

Retrieves information about a requester gateway.

Parameter Syntax

$result = $client->getRequesterGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activeLinksCount' => <integer>,
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainName' => '<string>',
    'gatewayId' => '<string>',
    'securityGroupIds' => ['<string>', ...],
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'totalLinksCount' => <integer>,
    'updatedAt' => <DateTime>,
    'vpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get requester gateway details

Get requester gateway

$result = $client->getRequesterGateway([
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'activeLinksCount' => 2,
    'createdAt' => ,
    'description' => 'My requester gateway',
    'domainName' => 'rtb-gw-12345678.example.com',
    'gatewayId' => 'rtb-gw-12345678',
    'securityGroupIds' => [
        'sg-12345678',
    ],
    'status' => 'ACTIVE',
    'subnetIds' => [
        'subnet-12345678',
        'subnet-87654321',
    ],
    'totalLinksCount' => 5,
    'updatedAt' => ,
    'vpcId' => 'vpc-12345678',
]

GetResponderGateway

$result = $client->getResponderGateway([/* ... */]);
$promise = $client->getResponderGatewayAsync([/* ... */]);

Retrieves information about a responder gateway.

Parameter Syntax

$result = $client->getResponderGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activeLinksCount' => <integer>,
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainName' => '<string>',
    'externalInboundEndpoint' => '<string>',
    'gatewayId' => '<string>',
    'gatewayType' => 'EXTERNAL|INTERNAL',
    'inboundLinksCount' => <integer>,
    'linksRequestedCount' => <integer>,
    'listenerConfig' => [
        'protocols' => ['<string>', ...],
    ],
    'managedEndpointConfiguration' => [
        'autoScalingGroups' => [
            'autoScalingGroupNames' => ['<string>', ...],
            'healthCheckConfig' => [
                'healthyThresholdCount' => <integer>,
                'intervalSeconds' => <integer>,
                'path' => '<string>',
                'port' => <integer>,
                'protocol' => 'HTTP|HTTPS',
                'statusCodeMatcher' => '<string>',
                'timeoutMs' => <integer>,
                'unhealthyThresholdCount' => <integer>,
            ],
            'roleArn' => '<string>',
        ],
        'eksEndpoints' => [
            'clusterApiServerCaCertificateChain' => '<string>',
            'clusterApiServerEndpointUri' => '<string>',
            'clusterName' => '<string>',
            'endpointsResourceName' => '<string>',
            'endpointsResourceNamespace' => '<string>',
            'roleArn' => '<string>',
        ],
    ],
    'port' => <integer>,
    'protocol' => 'HTTP|HTTPS',
    'securityGroupIds' => ['<string>', ...],
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'totalLinksCount' => <integer>,
    'trustStoreConfiguration' => [
        'certificateAuthorityCertificates' => ['<string>', ...],
    ],
    'updatedAt' => <DateTime>,
    'vpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Get responder gateway details

Get responder gateway

$result = $client->getResponderGateway([
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'activeLinksCount' => 2,
    'createdAt' => ,
    'description' => 'My responder gateway',
    'gatewayId' => 'rtb-gw-12345678',
    'inboundLinksCount' => 3,
    'linksRequestedCount' => 3,
    'port' => 443,
    'protocol' => 'HTTPS',
    'securityGroupIds' => [
        'sg-12345678',
    ],
    'status' => 'ACTIVE',
    'subnetIds' => [
        'subnet-12345678',
        'subnet-87654321',
    ],
    'totalLinksCount' => 5,
    'updatedAt' => ,
    'vpcId' => 'vpc-12345678',
]

ListCertificateAssociations

$result = $client->listCertificateAssociations([/* ... */]);
$promise = $client->listCertificateAssociationsAsync([/* ... */]);

Lists the certificate associations for a responder gateway.

Parameter Syntax

$result = $client->listCertificateAssociations([
    'gatewayId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'certificateAssociations' => [
        [
            'acmCertificateArn' => '<string>',
            'associatedAt' => <DateTime>,
            'status' => 'PENDING_ASSOCIATION|ASSOCIATED|PENDING_DISASSOCIATION|DISASSOCIATED|FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List certificate associations for a responder gateway

Retrieve all certificate associations for a responder gateway

$result = $client->listCertificateAssociations([
    'gatewayId' => 'rtb-gw-12345678',
    'maxResults' => 5,
]);

Result syntax:

[
    'certificateAssociations' => [
        [
            'acmCertificateArn' => 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
            'associatedAt' => ,
            'status' => 'ASSOCIATED',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'token123',
]

ListLinkRoutingRules

$result = $client->listLinkRoutingRules([/* ... */]);
$promise = $client->listLinkRoutingRulesAsync([/* ... */]);

Lists the routing rules for a link.

Parameter Syntax

$result = $client->listLinkRoutingRules([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'rules' => [
        [
            'conditions' => [
                'hostHeader' => '<string>',
                'hostHeaderWildcard' => '<string>',
                'pathExact' => '<string>',
                'pathPrefix' => '<string>',
                'queryStringEquals' => [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                'queryStringExists' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'priority' => <integer>,
            'ruleId' => '<string>',
            'status' => 'CREATION_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETION_IN_PROGRESS|DELETED|FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List link routing rules

List all routing rules for a link

$result = $client->listLinkRoutingRules([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'maxResults' => 10,
]);

Result syntax:

[
    'nextToken' => 'token123',
    'rules' => [
        [
            'conditions' => [
                'hostHeader' => 'api.customer.com',
            ],
            'createdAt' => ,
            'priority' => 10,
            'ruleId' => 'rule-abc123def456',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
]

ListLinks

$result = $client->listLinks([/* ... */]);
$promise = $client->listLinksAsync([/* ... */]);

Lists links associated with gateways.

Returns a list of all links for the specified gateways, including their status and configuration details.

Parameter Syntax

$result = $client->listLinks([
    'gatewayId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'links' => [
        [
            'attributes' => [
                'customerProvidedId' => '<string>',
                'responderErrorMasking' => [
                    [
                        'action' => 'NO_BID|PASSTHROUGH',
                        'httpCode' => '<string>',
                        'loggingTypes' => ['<string>', ...],
                        'responseLoggingPercentage' => <float>,
                    ],
                    // ...
                ],
            ],
            'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
            'createdAt' => <DateTime>,
            'direction' => 'RESPONSE|REQUEST',
            'flowModules' => [
                [
                    'dependsOn' => ['<string>', ...],
                    'moduleParameters' => [
                        'noBid' => [
                            'passThroughPercentage' => <float>,
                            'reason' => '<string>',
                            'reasonCode' => <integer>,
                        ],
                        'openRtbAttribute' => [
                            'action' => [
                                'headerTag' => [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                'noBid' => [
                                    'noBidReasonCode' => <integer>,
                                ],
                            ],
                            'filterConfiguration' => [
                                [
                                    'criteria' => [
                                        [
                                            'path' => '<string>',
                                            'values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'filterType' => 'INCLUDE|EXCLUDE',
                            'holdbackPercentage' => <float>,
                        ],
                        'rateLimiter' => [
                            'tps' => <float>,
                        ],
                    ],
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                // ...
            ],
            'gatewayId' => '<string>',
            'linkId' => '<string>',
            'logSettings' => [
                'applicationLogs' => [
                    'sampling' => [
                        'errorLog' => <float>,
                        'filterLog' => <float>,
                    ],
                ],
            ],
            'peerGatewayId' => '<string>',
            'pendingFlowModules' => [
                [
                    'dependsOn' => ['<string>', ...],
                    'moduleParameters' => [
                        'noBid' => [
                            'passThroughPercentage' => <float>,
                            'reason' => '<string>',
                            'reasonCode' => <integer>,
                        ],
                        'openRtbAttribute' => [
                            'action' => [
                                'headerTag' => [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                'noBid' => [
                                    'noBidReasonCode' => <integer>,
                                ],
                            ],
                            'filterConfiguration' => [
                                [
                                    'criteria' => [
                                        [
                                            'path' => '<string>',
                                            'values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'filterType' => 'INCLUDE|EXCLUDE',
                            'holdbackPercentage' => <float>,
                        ],
                        'rateLimiter' => [
                            'tps' => <float>,
                        ],
                    ],
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                // ...
            ],
            'publicEndpoint' => '<string>',
            'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List links for a gateway

Lists all links for the specified gateway

$result = $client->listLinks([
    'gatewayId' => 'rtb-gw-12345678',
    'maxResults' => 10,
]);

Result syntax:

[
    'links' => [
        [
            'createdAt' => ,
            'gatewayId' => 'rtb-gw-12345678',
            'linkId' => 'link-87654321',
            'peerGatewayId' => 'rtb-gw-87654321',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
]

ListRequesterGateways

$result = $client->listRequesterGateways([/* ... */]);
$promise = $client->listRequesterGatewaysAsync([/* ... */]);

Lists requester gateways.

Parameter Syntax

$result = $client->listRequesterGateways([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'gatewayIds' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List requester gateways with default pagination

Lists requester gateways using default pagination settings

$result = $client->listRequesterGateways([
    'maxResults' => 10,
]);

Result syntax:

[
    'gatewayIds' => [
        'rtb-gw-12345',
        'rtb-gw-67890',
    ],
]

Example 2: List requester gateways with pagination token

Lists requester gateways using a pagination token to get the next page

$result = $client->listRequesterGateways([
    'maxResults' => 5,
    'nextToken' => 'eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLTEyMzQ1In19fQ==',
]);

Result syntax:

[
    'gatewayIds' => [
        'rtb-gw-12345',
        'rtb-gw-09876',
    ],
    'nextToken' => 'eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLWZnaGlqIn19fQ==',
]

ListResponderGateways

$result = $client->listResponderGateways([/* ... */]);
$promise = $client->listResponderGatewaysAsync([/* ... */]);

Lists reponder gateways.

Parameter Syntax

$result = $client->listResponderGateways([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'gatewayIds' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List responder gateways with default pagination

Lists responder gateways using default pagination settings

$result = $client->listResponderGateways([
    'maxResults' => 10,
]);

Result syntax:

[
    'gatewayIds' => [
        'rtb-gw-54321',
        'rtb-gw-09876',
    ],
]

Example 2: List responder gateways with pagination token

Lists responder gateways using a pagination token to get the next page

$result = $client->listResponderGateways([
    'maxResults' => 3,
    'nextToken' => 'eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=',
]);

Result syntax:

[
    'gatewayIds' => [
        'rtb-gw-12345',
        'rtb-gw-09876',
    ],
    'nextToken' => 'eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC1hYmMzNCJ9fX0=',
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: List tags for a resource

Lists tags for a resource

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678',
]);

Result syntax:

[
    'tags' => [
        'Environment' => 'Production',
        'Team' => 'RTB',
    ],
]

RejectLink

$result = $client->rejectLink([/* ... */]);
$promise = $client->rejectLinkAsync([/* ... */]);

Rejects a link request between gateways.

When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.

Parameter Syntax

$result = $client->rejectLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        'customerProvidedId' => '<string>',
        'responderErrorMasking' => [
            [
                'action' => 'NO_BID|PASSTHROUGH',
                'httpCode' => '<string>',
                'loggingTypes' => ['<string>', ...],
                'responseLoggingPercentage' => <float>,
            ],
            // ...
        ],
    ],
    'connectivityType' => 'DEFAULT|PUBLIC_INGRESS|PUBLIC_EGRESS|EXTERNAL_INBOUND',
    'createdAt' => <DateTime>,
    'direction' => 'RESPONSE|REQUEST',
    'flowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'linkId' => '<string>',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => <float>,
                'filterLog' => <float>,
            ],
        ],
    ],
    'peerGatewayId' => '<string>',
    'pendingFlowModules' => [
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [
                        'headerTag' => [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [
                        [
                            'criteria' => [
                                [
                                    'path' => '<string>',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE',
                    'holdbackPercentage' => <float>,
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Reject a link request

Rejects a requested link request

$result = $client->rejectLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
]);

Result syntax:

[
    'createdAt' => ,
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'peerGatewayId' => 'rtb-gw-87654321',
    'status' => 'REJECTED',
    'updatedAt' => ,
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Add tags to a resource

Adds tags to a resource

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678',
    'tags' => [
        'Environment' => 'Production',
        'Team' => 'RTB',
    ],
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Remove tags from a resource

Removes tags from a resource

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678',
    'tagKeys' => [
        'Environment',
        'Team',
    ],
]);

Result syntax:

[
]

UpdateLink

$result = $client->updateLink([/* ... */]);
$promise = $client->updateLinkAsync([/* ... */]);

Updates the configuration of a link between gateways.

Allows you to modify settings and parameters for an existing link.

Parameter Syntax

$result = $client->updateLink([
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'logSettings' => [
        'applicationLogs' => [ // REQUIRED
            'sampling' => [ // REQUIRED
                'errorLog' => <float>, // REQUIRED
                'filterLog' => <float>, // REQUIRED
            ],
        ],
    ],
    'timeoutInMillis' => <integer>,
]);

Parameter Details

Result Syntax

[
    'linkId' => '<string>',
    'status' => 'PENDING_CREATION|PENDING_REQUEST|REQUESTED|ACCEPTED|ACTIVE|REJECTED|FAILED|PENDING_DELETION|DELETED|PENDING_UPDATE|PENDING_ISOLATION|ISOLATED|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Update link settings

Updates configuration settings for an existing link

$result = $client->updateLink([
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'logSettings' => [
        'applicationLogs' => [
            'sampling' => [
                'errorLog' => 100,
                'filterLog' => 10,
            ],
        ],
    ],
]);

Result syntax:

[
    'linkId' => 'link-87654321',
    'status' => 'ACTIVE',
]

UpdateLinkModuleFlow

$result = $client->updateLinkModuleFlow([/* ... */]);
$promise = $client->updateLinkModuleFlowAsync([/* ... */]);

Updates a link module flow.

Parameter Syntax

$result = $client->updateLinkModuleFlow([
    'clientToken' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'modules' => [ // REQUIRED
        [
            'dependsOn' => ['<string>', ...],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => <float>,
                    'reason' => '<string>',
                    'reasonCode' => <integer>,
                ],
                'openRtbAttribute' => [
                    'action' => [ // REQUIRED
                        'headerTag' => [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        'noBid' => [
                            'noBidReasonCode' => <integer>,
                        ],
                    ],
                    'filterConfiguration' => [ // REQUIRED
                        [
                            'criteria' => [ // REQUIRED
                                [
                                    'path' => '<string>', // REQUIRED
                                    'values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'filterType' => 'INCLUDE|EXCLUDE', // REQUIRED
                    'holdbackPercentage' => <float>, // REQUIRED
                ],
                'rateLimiter' => [
                    'tps' => <float>,
                ],
            ],
            'name' => '<string>', // REQUIRED
            'version' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result 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',
]

Result Details

Errors

ServiceQuotaExceededException:

The request could not be completed because you exceeded a service quota.

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Update link module flow

Update link module flow for link

$result = $client->updateLinkModuleFlow([
    'clientToken' => 'randomClientToken',
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'modules' => [
        [
            'version' => '1dot0dot0',
            'name' => 'noBidModule',
            'dependsOn' => [
            ],
            'moduleParameters' => [
                'noBid' => [
                    'passThroughPercentage' => 50,
                    'reason' => 'test',
                    'reasonCode' => 1,
                ],
            ],
        ],
    ],
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'status' => 'ACTIVE',
]

UpdateLinkRoutingRule

$result = $client->updateLinkRoutingRule([/* ... */]);
$promise = $client->updateLinkRoutingRuleAsync([/* ... */]);

Updates a routing rule for a link.

Parameter Syntax

$result = $client->updateLinkRoutingRule([
    'conditions' => [ // REQUIRED
        'hostHeader' => '<string>',
        'hostHeaderWildcard' => '<string>',
        'pathExact' => '<string>',
        'pathPrefix' => '<string>',
        'queryStringEquals' => [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        'queryStringExists' => '<string>',
    ],
    'gatewayId' => '<string>', // REQUIRED
    'linkId' => '<string>', // REQUIRED
    'priority' => <integer>, // REQUIRED
    'ruleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ruleId' => '<string>',
    'status' => 'CREATION_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETION_IN_PROGRESS|DELETED|FAILED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Update a link routing rule

Update the conditions of a routing rule

$result = $client->updateLinkRoutingRule([
    'conditions' => [
        'hostHeader' => 'api.customer.com',
        'pathPrefix' => '/openrtb/',
    ],
    'gatewayId' => 'rtb-gw-12345678',
    'linkId' => 'link-87654321',
    'priority' => 20,
    'ruleId' => 'rule-abc123def456',
]);

Result syntax:

[
    'ruleId' => 'rule-abc123def456',
    'status' => 'UPDATE_IN_PROGRESS',
    'updatedAt' => ,
]

UpdateRequesterGateway

$result = $client->updateRequesterGateway([/* ... */]);
$promise = $client->updateRequesterGatewayAsync([/* ... */]);

Updates a requester gateway.

Parameter Syntax

$result = $client->updateRequesterGateway([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'gatewayId' => '<string>',
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Update requester gateway

Update requester gateway

$result = $client->updateRequesterGateway([
    'clientToken' => '12345678-1234-1234-1234-123456789012',
    'description' => 'Updated requester gateway description',
    'gatewayId' => 'rtb-gw-12345678',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_UPDATE',
]

UpdateResponderGateway

$result = $client->updateResponderGateway([/* ... */]);
$promise = $client->updateResponderGatewayAsync([/* ... */]);

Updates a responder gateway.

Parameter Syntax

$result = $client->updateResponderGateway([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'domainName' => '<string>',
    'gatewayId' => '<string>', // REQUIRED
    'listenerConfig' => [
        'protocols' => ['<string>', ...], // REQUIRED
    ],
    'managedEndpointConfiguration' => [
        'autoScalingGroups' => [
            'autoScalingGroupNames' => ['<string>', ...], // REQUIRED
            'healthCheckConfig' => [
                'healthyThresholdCount' => <integer>,
                'intervalSeconds' => <integer>,
                'path' => '<string>', // REQUIRED
                'port' => <integer>, // REQUIRED
                'protocol' => 'HTTP|HTTPS',
                'statusCodeMatcher' => '<string>',
                'timeoutMs' => <integer>,
                'unhealthyThresholdCount' => <integer>,
            ],
            'roleArn' => '<string>', // REQUIRED
        ],
        'eksEndpoints' => [
            'clusterApiServerCaCertificateChain' => '<string>', // REQUIRED
            'clusterApiServerEndpointUri' => '<string>', // REQUIRED
            'clusterName' => '<string>', // REQUIRED
            'endpointsResourceName' => '<string>', // REQUIRED
            'endpointsResourceNamespace' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
    ],
    'port' => <integer>, // REQUIRED
    'protocol' => 'HTTP|HTTPS', // REQUIRED
    'trustStoreConfiguration' => [
        'certificateAuthorityCertificates' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'gatewayId' => '<string>',
    'status' => 'PENDING_CREATION|ACTIVE|PENDING_DELETION|DELETED|ERROR|PENDING_UPDATE|ISOLATED|PENDING_ISOLATION|PENDING_RESTORATION',
]

Result Details

Errors

ResourceNotFoundException:

The request could not be completed because the resource does not exist.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have sufficient access to perform this action.

ConflictException:

The request could not be completed because of a conflict in the current state of the resource.

InternalServerException:

The request could not be completed because of an internal server error. Try your call again.

ValidationException:

The request could not be completed because it fails satisfy the constraints specified by the service.

Examples

Example 1: Update responder gateway

Update responder gateway

$result = $client->updateResponderGateway([
    'clientToken' => '12345678-1234-1234-1234-123456789012',
    'description' => 'Updated responder gateway description',
    'gatewayId' => 'rtb-gw-12345678',
    'port' => 8080,
    'protocol' => 'HTTP',
]);

Result syntax:

[
    'gatewayId' => 'rtb-gw-12345678',
    'status' => 'PENDING_UPDATE',
]