Class StsClient
- Aws\AwsClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
-
Aws\Sts\StsClient
- Namespace: Aws\Sts
- Located at Sts/StsClient.php
This client is used to interact with the AWS Security Token Service (AWS STS).
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version option given when constructing the
client. The version option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */), or using the
$\client->getCommand method of the client.
Methods Summary
-
__construct ( array $args )
The client constructor accepts the following options:
-
createCredentials ( Aws\Result $result )
Creates credentials from the result of an STS operations
Methods inherited from Aws\AwsClient
__sleep(),
applyDocFilters(),
factory(),
getApi(),
getArguments(),
getClientBuiltIns(),
getClientContextParams(),
getCommand(),
getConfig(),
getCredentials(),
getEndpoint(),
getEndpointProvider(),
getEndpointProviderArgs(),
getHandlerList(),
getRegion(),
getSignatureProvider()
Methods inherited from Aws\AwsClientInterface
Methods used from Aws\AwsClientTrait
Methods Details
__construct ( array $args )
The client constructor accepts the following options:
In addition to the options available to \Aws\AwsClient::__construct, StsClient accepts the following options:
- sts_regional_endpoints: (Aws\Sts\RegionalEndpoints\ConfigurationInterface|Aws\CacheInterface|callable|string|array) Specifies whether to use regional or legacy endpoints for legacy regions. Provide an Aws\Sts\RegionalEndpoints\ConfigurationInterface object, an instance of Aws\CacheInterface, a callable configuration provider used to create endpoint configuration, a string value of
legacyorregional, or an associative array with the following keys: endpoint_types (string) Set tolegacyorregional, defaults tolegacy
Parameters
| array | $args |
Exceptions
| InvalidArgumentException if any required options are missing or the service is not supported. |
Overrides
Aws\Credentials\Credentials
createCredentials (
Aws\Result
$result
)
Creates credentials from the result of an STS operations
Parameters
Aws\Result |
$result | Result of an STS operation |
Returns
Aws\Credentials\Credentials |
Exceptions
| InvalidArgumentException if the result contains no credentials |