SDK for PHP V3

EndpointProviderV2
in package

Given a service's ruleset and client-provided input parameters, provides either an object reflecting the properties of a resolved endpoint, or throws an error.

Supports both the classic decision tree ruleset (endpointRuleSet trait) and the binary decision diagram ruleset (endpointBdd trait). A raw definition array is always interpreted as a tree ruleset; to use a BDD, construct a BddRuleset and hand it in directly.

Table of Contents

Methods

__construct()  : mixed
getActiveParameters()  : array<string|int, mixed>
getBddRuleset()  : BddRuleset|null
Returns the parsed BDD ruleset for services using the `endpointBdd` trait, or null when the provider was built from a tree ruleset.
getRuleset()  : Ruleset|null
Returns the parsed tree ruleset for services using the legacy `endpointRuleSet` trait. Returns null when the provider was built from an `endpointBdd` trait.
resolveEndpoint()  : RulesetEndpoint
Given input parameters, determines the correct endpoint or an error to be thrown for a given request.

Methods

__construct()

public __construct(array<string|int, mixed>|Ruleset|BddRuleset $ruleset, array<string|int, mixed> $partitions) : mixed
Parameters
$ruleset : array<string|int, mixed>|Ruleset|BddRuleset

A parsed ruleset instance, or a raw tree ruleset array from the service model.

$partitions : array<string|int, mixed>

AWS partitions data. Ignored when $ruleset is already a parsed instance, since the instance carries its own partition data.

getActiveParameters()

public getActiveParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBddRuleset()

Returns the parsed BDD ruleset for services using the `endpointBdd` trait, or null when the provider was built from a tree ruleset.

public getBddRuleset() : BddRuleset|null
Return values
BddRuleset|null

getRuleset()

Returns the parsed tree ruleset for services using the legacy `endpointRuleSet` trait. Returns null when the provider was built from an `endpointBdd` trait.

public getRuleset() : Ruleset|null
Return values
Ruleset|null

resolveEndpoint()

Given input parameters, determines the correct endpoint or an error to be thrown for a given request.

public resolveEndpoint(array<string|int, mixed> $inputParameters) : RulesetEndpoint
Parameters
$inputParameters : array<string|int, mixed>
Tags
throws
UnresolvedEndpointException
Return values
RulesetEndpoint
<-- modeled_exceptions -->
On this page