SDK for PHP 3.x

PartitionInterface
in

Represents a section of the AWS cloud.

Table of Contents

Methods

__invoke()  : array<string|int, mixed>
A partition must be invokable as an endpoint provider.
getAvailableEndpoints()  : array<string|int, string>
Return the endpoints supported by a given service.
getName()  : string
Returns the partition's short name, e.g., 'aws,' 'aws-cn,' or 'aws-us-gov.'
isRegionMatch()  : bool
Determine if this partition contains the provided region. Include the name of the service to inspect non-regional endpoints

Methods

__invoke()

A partition must be invokable as an endpoint provider.

public __invoke([array<string|int, mixed> $args = [] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = []
Tags
see
EndpointProvider
Return values
array<string|int, mixed>

getAvailableEndpoints()

Return the endpoints supported by a given service.

public getAvailableEndpoints(string $service[, bool $allowNonRegionalEndpoints = false ]) : array<string|int, string>
Parameters
$service : string

Identifier of the service whose endpoints should be listed (e.g., 's3' or 'ses')

$allowNonRegionalEndpoints : bool = false

Set to true to include endpoints that are not AWS regions (e.g., 'local' for DynamoDB or 'fips-us-gov-west-1' for S3)

Return values
array<string|int, string>

getName()

Returns the partition's short name, e.g., 'aws,' 'aws-cn,' or 'aws-us-gov.'

public getName() : string
Return values
string

isRegionMatch()

Determine if this partition contains the provided region. Include the name of the service to inspect non-regional endpoints

public isRegionMatch(string $region, string $service) : bool
Parameters
$region : string
$service : string
Return values
bool
On this page